Skip to Content

Arcade CLI Cheat Sheet

📄 Print-friendly! Use your browser’s print function (Ctrl/Cmd + P) to get a landscape-oriented version perfect for events and quick reference. The layout will automatically adjust for optimal printing.

🚀Getting Started

Install Arcade CLI globally using uv (recommended) or pip.

Terminal
uv tool install arcade-mcp # Recommended pip install arcade-mcp # Alternative

Verify installation:

Terminal
arcade --version

Create and run your first server:

Terminal
arcade new my_server cd my_server arcade mcp http

Get help on any command:

Terminal
arcade --help arcade <command> --help
Use uv for faster installs and better dependency management
🔐Authentication

Authenticate with Arcade Cloud for deployments and secrets management.

CommandDescription
arcade loginOpens browser for OAuth authentication
arcade login --host <url>Login to custom Arcade instance
arcade logoutClear local credentials
arcade whoamiShow logged-in user and active context
arcade dashboardOpen Arcade web UI in browser
arcade dashboard --localOpen local dashboard

Credentials are stored in ~/.arcade/credentials.yaml

🏢Organizations & Projects

Organizations group and team members. Projects contain servers, secrets, and configurations.

Terminal
# List all organizations arcade org list # Switch active organization arcade org set <org_id>

Switching organization also resets your active to that org’s default.

contain servers, secrets, and configurations.

Terminal
# List projects in active org arcade project list # Switch active project arcade project set <id>

All deploy/secret commands use your active project .

Use arcade whoami to see current org/.

Create New Server

Scaffold a new server with boilerplate code.

Minimal Template (Quick Start)

Terminal
arcade new my_server

Creates pyproject.toml, src/my_server/init.py, src/my_server/server.py.

Full Template (Production)

Terminal
arcade new my_server --full

Creates: pyproject.toml, my_server/ (package with ), tests/, evals/, Makefile, .pre-commit-config.yaml, .ruff.toml, LICENSE, README.md.

Options

FlagDescription
--dir <path>Output directory (default: current)
--full, -fCreate full starter project
Run MCP Server

Start your server locally for development and testing.

Transport Types

Terminal
# For MCP clients (Claude, Cursor) arcade mcp stdio # For web/API testing arcade mcp http

Examples

Terminal
arcade mcp http --port 8080 --reload --debug arcade mcp stdio --tool-package github arcade mcp http --discover-installed --show-packages
Use --reload for faster development iteration
🔍Show & Inspect Tools

View available and their schemas from local or remote servers.

Terminal
# List all tools arcade show # Show local tools only arcade show --local # Show tool details arcade show -t <tool_name> # Full response structure arcade show -t <tool> --full # Filter by server arcade show -T <server_name>

Options

FlagDescription
-t, --tool <name>Show specific tool details
-T, --server <name>Filter by server
--local, -lShow local catalog only
--full, -fShow complete response (auth, logs)
🔧Configure Clients

Auto-configure clients to connect to your server.

Supported Clients

ClientCommand
Claude Desktop
(stdio only)
arcade configure claude
Cursor IDE
(stdio or http)
arcade configure cursor
VS Code
(stdio or http)
arcade configure vscode
Claude Desktop only supports stdio transport via configuration file.

Options

FlagDescriptionDefault
--transport <type>stdio or httpstdio
--host <target>local or arcadelocal
--port <port>Port for HTTP transport8000
--name <name>Server name in configdirectory name
--entrypoint <file>Entry file for stdioserver.py
☁️Deploy to Cloud

Deploy your server to Arcade Cloud for production use.

Terminal
arcade deploy

Options

FlagDescriptionDefault
-e, --entrypoint <file>Python file that runs MCPAppserver.py
--server-name <name>Explicit server nameauto-detected
--server-version <ver>Explicit server versionauto-detected
--skip-validateSkip local health checksoff
--secrets <mode>Secret sync mode (see below)auto

Secrets Handling

ModeDescription
autoSync only required secret keys (default)
allSync entire .env file
skipDon’t sync any secrets
Run from your project root (where pyproject.toml is located).
🖥️Server Management

Manage deployed servers in Arcade Cloud.

Terminal
# List all servers arcade server list # Get server details arcade server get <name> # Enable a server arcade server enable <name> # Disable a server arcade server disable <name> # Delete a server (permanent!) arcade server delete <name>

Delete is permanent and cannot be undone

📋Server Logs

View and stream logs from deployed servers.

Terminal
# View recent logs (last 1h) arcade server logs <name> # Stream live logs arcade server logs <name> -f # Stream live logs

Time Range Options

FlagDescriptionExample
-s, --since <time>Start time (default: 1h)1h, 30m, 2d, 2024-01-15T10:00:00Z
-u, --until <time>End time (default: now)30m, 2024-01-15T12:00:00Z
Terminal
arcade server logs myserver --since 2h --until 30m arcade server logs myserver --since 2024-01-15T10:00:00Z
🔑Secrets Management

Store API keys and sensitive configuration for your deployed servers. Secrets are encrypted and scoped to your active .

List Secrets

Terminal
arcade secret list

Shows: Key, Type, Description, Last accessed.

Set Secrets

Terminal
arcade secret set KEY=value arcade secret set KEY1=v1 KEY2=v2

From .env File

Terminal
arcade secret set --from-env arcade secret set --from-env -f .env.prod

Delete Secrets

Terminal
arcade secret unset KEY1 KEY2

Use arcade secret set --from-env to sync local .env to Arcade Cloud before deploying.

📊Evaluations

Test -calling accuracy with evaluation suites.

Run Evaluations

Terminal
arcade evals # Current dir arcade evals ./evals/ # Specific dir

Capture Mode

Terminal
arcade evals --capture

Output Options

FlagDescription
--details, -dShow detailed results
--failed-only, -fShow only failed evals
--file <path>Write results to file
--format <fmt>Output format: txt, md, html, json, all
--max-concurrent <n>Concurrent evaluations (default: 1)
--add-contextInclude system/additional messages
⚙️MCP Server Options
—hostBind address (127.0.0.1)
—portPort number (8000)
—reloadAuto-reload on changes
—debugVerbose logging
—tool-packageLoad specific package
—discover-installedFind arcade-* packages
—show-packagesList loaded packages
—env-filePath to .env file
—nameServer name
—versionServer version
—otel-enableSend logs to OTel
🚩Global Flags

Available on most commands:

FlagDescription
-h, --helpShow command help
-v, --versionShow CLI version
-d, --debugEnable debug output
--host <url>Arcade Engine host
--port <port>Arcade Engine port
--tlsForce TLS connection
--no-tlsDisable TLS connection

Use --debug when troubleshooting issues

🌐Environment Variables

Set these in your shell or .env file:

VariableDescription
OPENAI_API_KEYOpenAI API key (for evals)
ANTHROPIC_API_KEYAnthropic API key (for evals)
ARCADE_API_BASE_URLOverride Arcade API URL
Terminal
# In shell export OPENAI_API_KEY=sk-... # Or in .env file OPENAI_API_KEY=sk-... ANTHROPIC_API_KEY=sk-ant-...
📂Project Structure

Minimal Template (arcade new my_server)

my_server/ ├── pyproject.toml # Dependencies & metadata └── src/my_server/ ├── init.py └── server.py # MCPApp entry point

Full Template (arcade new my_server --full)

my_server/ ├── pyproject.toml # Dependencies & metadata ├── .pre-commit-config.yaml # Git hooks ├── .ruff.toml # Linter config ├── Makefile # Common commands ├── LICENSE ├── README.md ├── my_server/ # Package directory │ ├── init.py │ └── / │ ├── init.py │ └── hello.py # Example tool ├── tests/ │ ├── init.py │ └── test_my_server.py └── evals/ └── eval_my_server.py # Evaluation suites

Add .env (local secrets) and .env.example (template) to your .

🔧Troubleshooting

Common Issues

ErrorSolution
”Not logged in”Run arcade login
”Legacy credentials”Run arcade logout then arcade login
”Module not found”Run uv pip install arcade-mcp[evals]
”Server not healthy”Check arcade server logs <name> -f
”No tools found”Verify --tool-package or --discover-installed

Debug Tips

Terminal
arcade --debug <command> # Verbose output arcade server logs <name> -f # Stream live logs arcade show --local # Verify local tools
💡Pro Tips
  • Use --reload during development for faster iteration
  • Use stdio transport for Claude Desktop and Cursor
  • Use http transport for web testing and debugging
  • Always set secrets before deploying servers
  • Run evaluations before every deploy
  • Use --full template for production
  • Check logs immediately after deploying
  • Use --debug flag to see detailed request info
  • Keep .env.example updated for your team
  • Use project when working with multiple
📝Typical Workflow

Standard development cycle for building servers:

  1. arcade login — Authenticate with Arcade Cloud
  2. arcade new my_server — Create (Minimal template)
  3. Edit src/my_server/server.py — Add your
  4. arcade mcp http --reload — Run locally with hot reload
  5. arcade configure cursor — Connect your IDE
  6. Test in IDE — Verify functionality
  7. arcade evals — Run evaluation suites
  8. arcade secret set --from-env — Sync secrets
  9. arcade deploy — Deploy to cloud (requires server.py entrypoint)
  10. arcade server logs -f — Monitor logs
Last updated on

Arcade CLI Cheat Sheet | Arcade Docs