Install a tool or toolkit

PyPI Installation

All the Arcade AI-built tools and toolkits are available on PyPI. To install a tool or toolkit, run:

pip install arcade-[toolkit_name]

in the same environment as the arcade-ai package.

For example, to install the math tools, run:

pip install arcade-math

To verify the installation, run:

arcade show

which should return output similar to:

┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
┃ Name         ┃ Description                  ┃ Toolkit ┃ Version ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━┩
│ Math.Add     │ Add two numbers together     │  Math   │  0.1.0  │
└──────────────┴──────────────────────────────┴─────────┴─────────┘

These are all tools that are installed in the same environment as the arcade-ai package.

See our Toolkits Integrations for all available toolkits and individual installation instructions.

Local Package Installation

Locally built toolkits can also be installed with:

pip install .

pip install <wheel_name>

in the same environment as the arcade-ai package.

Hosted Toolkits

To add a toolkit to a hosted actor such as FastAPI, you can register them in the actor itself. This allows you to explicitly define which tools should be included on a particular actor.

import arcade_math
 
app = FastAPI()
 
actor_secret = os.environ.get("ARCADE_ACTOR_SECRET")
actor = FastAPIActor(app, secret=actor_secret)
 
actor.register_toolkit(Toolkit.from_module(arcade_math))

For a full example, see the Building an actor with FastAPI

Showing Tools From a Hosted Engine

To show all tools that are available on an engine, you can run

arcade show -h <engine_host> -p <engine_port>

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ Name                                   ┃ Description                                                               ┃ Package  ┃ Version ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ Github.CountStargazers                 │ Count the number of stargazers (stars) for a GitHub repository.           │ Github   │ 0.0.15  │
│ Github.CreateIssue                     │ Create an issue in a GitHub repository.                                   │ Github   │ 0.0.15  │
│ Github.CreateIssueComment              │ Create a comment on an issue in a GitHub repository.                      │ Github   │ 0.0.15  │
│ Github.CreateReplyForReviewComment     │ Create a reply to a review comment for a pull request.                    │ Github   │ 0.0.15  │
│ Github.CreateReviewComment             │ Create a review comment for a pull request in a GitHub repository.        │ Github   │ 0.0.15  │
│ Github.GetPullRequest                  │ Get details of a pull request in a GitHub repository.                     │ Github   │ 0.0.15  │
│ Github.GetRepository                   │ Get a repository.                                                         │ Github   │ 0.0.15  │
....

Authenticated Tools

Some Toolkits may need authentication through an API key or OAuth, which can be configured in the Arcade Engine. To see the specific configuration requirements, you can checkout our OAuth Providers or see required authentication provider in the Toolkit Description of each tool.

Docker Overview