Quickstart
First, make sure you have these pre-requisites installed on your system:
- Python 3.10 or higher
Verify your Python version by runningpython --version
orpython3 --version
in your terminal. - pip: The Python package installer should be available. It's typically included with Python.
- Arcade AI Account: Sign up for an Arcade AI account (opens in a new tab) if you haven't already.
Let's set up Arcade AI and give it a try!
Install Arcade AI
pip install 'arcade-ai[fastapi]'
This will install the arcade
CLI and our development SDK.
Log in to Arcade AI
arcade login
Your Arcade API key will be saved to ~/.arcade/credentials.yaml
.
Try arcade chat
With Arcade CLI installed, you can test out our API with the arcade chat
command:
arcade chat
This launches a chat with the Arcade Cloud Engine (hosted at api.arcade-ai.com
). All pre-built Arcade tools are available to use.
For example, try asking:
star the ArcadeAI/arcade-ai repo on Github
Arcade AI will ask you to authorize with GitHub, and then the AI assistant will star the ArcadeAI/arcade-ai (opens in a new tab) repo on your behalf.
You'll see output similar to this:
Assistant (gpt-4o):
I starred the ArcadeAI/arcade-ai repo on Github for you!
You can use Ctrl-C to exit the chat at any time.
Try more tools
Try prompting the AI with different requests:
- Search the web to find when The Winds of Winter will be released
- Summarize my emails from today
- What's playing on my Spotify right now?
To see all tools available in the Cloud, run:
arcade show
Great job! 🎉 You've set up Arcade AI and used your first tool.
Next steps
- Learn about tools and how they work
- Learn how to call tools with LLMs
- Or, jump ahead to building your own custom tools