Quickstart

First, make sure you have these pre-requisites installed on your system:

Python 3.10 or higher
Verify your Python version by running python --version or python3 --version in your terminal.
pip: The Python package installer should be available. It’s typically included with Python.
Arcade Account: Sign up for an Arcade account if you haven’t already.

Let’s set up Arcade and give it a try!

Install the Arcade CLI and SDK and log in. Your Arcade API key will be printed to the console as well as saved to ~/.arcade/credentials.yaml.

pip install 'arcade-ai[fastapi]'
arcade login

Obtaining an API key through the Arcade dashboard is coming soon!

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.dev). All pre-built Arcade tools are available to use.

For example, try asking:

star the ArcadeAI/arcade-ai repo on Github

Arcade will ask you to authorize with GitHub, and then the AI assistant will star the ArcadeAI/arcade-ai 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 prompting the AI with different requests:

To see all tools available in the Cloud, run:

arcade show

Great job! 🎉 You’ve set up Arcade and used your first tool.