Skip to content

Editorial improvements for #825 #829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 2 commits into from
Closed

Editorial improvements for #825 #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87d3241
Editorial: Structure - Changed title from "The Arcade CLI" to "Arcade…
github-actions[bot] Feb 26, 2026
173259d
Editorial: Structure - Added intro line after H1; Structure - Changed…
github-actions[bot] Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions app/en/references/arcade-cli/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ description: "Learn how to install and use the Arcade CLI"

import { Tabs, Callout } from "nextra/components";

# The Arcade CLI
# Arcade CLI

The Arcade CLI is a command-line tool that allows you to manage your Arcade deployments, generate, test, and manage your MCP servers, and more.
The Arcade CLI is a command-line tool that manages your Arcade deployments, generates, tests, and manages your MCP servers.

The Arcade CLI provides everything you need to build, test, and deploy MCP servers. You'll use it to create new server projects, run servers locally for development, configure MCP clients like Claude Desktop, and deploy your servers to Arcade Cloud. This reference covers installation, upgrades, and all available commands with their options.

## Install the Arcade CLI

Expand Down Expand Up @@ -64,7 +66,7 @@ arcade --version
```

<Callout type="info">
If you previously had the `arcade-ai` package installed, you should uninstall it first. The old `arcade-ai` CLI has been replaced by `arcade-mcp`. See the [migration guide](/guides/create-tools/migrate-toolkits) for details on migrating from legacy toolkits.
If you previously had the `arcade-ai` package installed, you should uninstall it first. The old `arcade-ai` CLI now uses `arcade-mcp`. See the [migration guide](/guides/create-tools/migrate-toolkits) for details on migrating from legacy toolkits.
</Callout>

### Re-authenticate after upgrading
Expand Down Expand Up @@ -304,10 +306,10 @@ You can learn more about any of the commands by running `arcade <command> --help
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────╮
│ --details -d Show detailed results │
│ --only-failed -f Show only failed cases │
│ --only failed -f Show only failed cases │
│ --capture Record tool calls without scoring│
│ --include-context Include conversation context │
│ --output -o TEXT Output file(s) (repeatable) │
│ --output -o TEXT Output files (repeatable) │
│ --use-provider -p TEXT Provider and models (repeatable)│
│ --api-key -k TEXT Provider API key (repeatable) │
│ --max-concurrent -c INTEGER Maximum number of concurrent │
Expand Down Expand Up @@ -340,7 +342,7 @@ Usage: arcade mcp [OPTIONS] [TRANSPORT]
│ [default: 127.0.0.1] │
│ --port INTEGER Port to bind to (HTTP mode only) │
│ [default: 8000] │
│ --tool-package,--package -p TEXT Specific tool package to load (e.g., │
│ --tool-package,--package -p TEXT Specific tool package to load (for example, │
│ 'github' for arcade-github) │
│ [default: None] │
│ --discover-installed,--all Discover all installed arcade tool │
Expand Down Expand Up @@ -382,23 +384,23 @@ Usage: arcade mcp [OPTIONS] [TRANSPORT]
╭─ Advanced ─────────────────────────────────────────────────────────────────────────╮
│ --skip-validate,--yolo Skip running the server locally │
│ for health/metadata checks. When │
│ set, you must provide │
│ you set this option, you must provide │
│ --server-name and │
│ --server-version. Secret handling │
│ is controlled by --secrets. │
│ --server-version. You control secret handling │
│ with --secrets. │
│ --server-name -n TEXT Explicit server name to use when │
│ --skip-validate is set. Only used │
│ when --skip-validate is set. │
│ you set --skip-validate. Only used │
│ when you set --skip-validate. │
│ [default: None] │
│ --server-version -v TEXT Explicit server version to use │
│ when --skip-validate is set. Only │
│ used when --skip-validate is set. │
│ when you set --skip-validate. Only │
│ used when you set --skip-validate. │
│ [default: None] │
│ --secrets -s [auto|all|skip] How to upsert secrets before │
│ deploy: auto (default): During │
│ validation, discover required │
│ secret KEYS and upsert only │
│ those. If --skip-validate is set, │
│ those. If you set --skip-validate, │
│ auto becomes skip. all: Upsert │
│ every key/value pair from your │
│ server's .env file regardless of │
Expand Down Expand Up @@ -500,8 +502,7 @@ Usage: arcade secret [OPTIONS] COMMAND [ARGS]...
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────╮
│ set Set tool secret(s) using KEY=VALUE pairs or from .env file │
│ set Set tool secret using KEY=VALUE pairs or from .env file │
│ list List all tool secrets in Arcade Cloud │
│ unset Delete tool secret(s) by key names │
╰────────────────────────────────────────────────────────────────────────────────────╯
```
│ unset Delete tool secret by key names │
╰────────────────────────────────────────────────────────────────────────────────────╯
79 changes: 40 additions & 39 deletions app/en/references/cli-cheat-sheet/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ import '../../../cheat-sheet-print.css'

# Arcade CLI cheat sheet

Quick reference for all Arcade CLI commands and workflows.

<div className="no-print mb-4 p-4 bg-blue-50 dark:bg-blue-900/20 rounded-lg border border-blue-200 dark:border-blue-800">
<strong>📄 Print-friendly!</strong> 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.
</div>

<CheatSheetGrid>

<CheatSheetSection title="Getting Started" icon="🚀" color="red">
<CheatSheetSection title="Getting started" icon="🚀" color="red">

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

Expand Down Expand Up @@ -75,11 +77,11 @@ import '../../../cheat-sheet-print.css'
| `arcade dashboard` | Open Arcade web UI in browser |
| `arcade dashboard --local` | Open local dashboard |

Credentials are stored in `~/.arcade/credentials.yaml`
Credentials store them in `~/.arcade/credentials.yaml`

</CheatSheetSection>

<CheatSheetSection title="Organizations & Projects" icon="🏢" color="purple">
<CheatSheetSection title="Organizations & projects" icon="🏢" color="purple">

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

Expand Down Expand Up @@ -111,7 +113,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Create New Server" icon="✨" color="green">
<CheatSheetSection title="Create new server" icon="✨" color="green">
Scaffold a new MCP server project with boilerplate code.

### Minimal Template (Quick Start)
Expand All @@ -138,7 +140,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Run MCP Server" icon="⚡" color="cyan">
<CheatSheetSection title="Run MCP server" icon="⚡" color="cyan">

Start your server locally for development and testing.

Expand All @@ -163,7 +165,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Show & Inspect Tools" icon="🔍" color="pink">
<CheatSheetSection title="Show & inspect tools" icon="🔍" color="pink">

View available tools and their schemas from local or remote servers.

Expand Down Expand Up @@ -195,7 +197,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Configure Clients" icon="🔧" color="yellow">
<CheatSheetSection title="Configure clients" icon="🔧" color="yellow">

Auto-configure MCP clients to connect to your server.

Expand All @@ -221,7 +223,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Deploy to Cloud" icon="☁️" color="red">
<CheatSheetSection title="Deploy to cloud" icon="☁️" color="red">

Deploy your MCP server to Arcade Cloud for production use.

Expand All @@ -247,11 +249,11 @@ import '../../../cheat-sheet-print.css'
| `all` | Sync entire .env file |
| `skip` | Don't sync any secrets |

<InfoBox type="tip">Run from your project root (where `pyproject.toml` is located).</InfoBox>
<InfoBox type="tip">Run from your project root (where `pyproject.toml` lives).</InfoBox>
</CheatSheetSection>


<CheatSheetSection title="Server Management" icon="🖥️" color="green">
<CheatSheetSection title="Server management" icon="🖥️" color="green">

Manage deployed servers in Arcade Cloud.

Expand All @@ -277,12 +279,12 @@ import '../../../cheat-sheet-print.css'
</InfoBox>
</CheatSheetSection>

<CheatSheetSection title="Server Logs" icon="📋" color="blue">
<CheatSheetSection title="Server logs" icon="📋" color="blue">

View and stream logs from deployed servers.

```bash
# View recent logs (last 1h)
# View recent logs (last 1 h)
arcade server logs <name>

# Stream live logs
Expand All @@ -293,19 +295,19 @@ import '../../../cheat-sheet-print.css'

| Flag | Description | Example |
|------|-------------|---------|
| `-s`, `--since <time>` | Start time (default: 1h) | `1h`, `30m`, `2d`, `2024-01-15T10:00:00Z` |
| `-s`, `--since <time>` | Start time (default: 1 h) | `1 h`, `30m`, `2 d`, `2024-01-15T10:00:00Z` |
| `-u`, `--until <time>` | End time (default: now) | `30m`, `2024-01-15T12:00:00Z` |

```bash
arcade server logs myserver --since 2h --until 30m
arcade server logs myserver --since 2 h --until 30m
arcade server logs myserver --since 2024-01-15T10:00:00Z
```

</CheatSheetSection>

<CheatSheetSection title="Secrets Management" icon="🔑" color="purple">
<CheatSheetSection title="Secrets management" icon="🔑" color="purple">

Store API keys and sensitive configuration for your deployed servers. Secrets are encrypted and scoped to your active project.
Store API keys and sensitive configuration for your deployed servers. All secrets use encryption and scoping to your active project.

### List Secrets
```bash
Expand Down Expand Up @@ -352,8 +354,8 @@ import '../../../cheat-sheet-print.css'
# Show detailed results
arcade evals -d

# Filter failed tests only
arcade evals --only-failed
# Filter only failed tests
arcade evals --only failed
```

### Capture Mode
Expand Down Expand Up @@ -399,7 +401,7 @@ import '../../../cheat-sheet-print.css'
### Common Workflows
```bash
# Debug failures
arcade evals --only-failed -d
arcade evals --only failed -d

# Full report with context
arcade evals -d --include-context -o report.html
Expand All @@ -419,8 +421,8 @@ import '../../../cheat-sheet-print.css'
| Flag | Short | Description |
|------|-------|-------------|
| `--details` | `-d` | Show detailed results |
| `--only-failed` | `-f` | Filter failed tests |
| `--output` | `-o` | Output file(s) |
| `--only failed` | `-f` | Filter failed tests |
| `--output` | `-o` | Output file |
| `--use-provider` | `-p` | Select provider/model |
| `--api-key` | `-k` | Provider API key |
| `--num-runs` | `-n` | Runs per case |
Expand All @@ -436,7 +438,7 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="MCP Server Options" icon="⚙️" color="pink">
<CheatSheetSection title="MCP server options" icon="⚙️" color="pink">
<div className="text-xs">
<table className="w-full">
<tbody>
Expand All @@ -457,7 +459,7 @@ import '../../../cheat-sheet-print.css'
</CheatSheetSection>


<CheatSheetSection title="Global Flags" icon="🚩" color="orange">
<CheatSheetSection title="Global flags" icon="🚩" color="orange">
Available on most commands:

| Flag | Description |
Expand All @@ -475,7 +477,7 @@ import '../../../cheat-sheet-print.css'
</InfoBox>
</CheatSheetSection>

<CheatSheetSection title="Environment Variables" icon="🌐" color="yellow">
<CheatSheetSection title="Environment variables" icon="🌐" color="yellow">
Set these in your shell or `.env` file:

| Variable | Description |
Expand All @@ -494,7 +496,7 @@ import '../../../cheat-sheet-print.css'
```
</CheatSheetSection>

<CheatSheetSection title="Project Structure" icon="📂" color="green">
<CheatSheetSection title="Project structure" icon="📂" color="green">

### Minimal Template (`arcade new my_server`)

Expand Down Expand Up @@ -562,7 +564,7 @@ import '../../../cheat-sheet-print.css'
```
</CheatSheetSection>

<CheatSheetSection title="Pro Tips" icon="💡" color="blue">
<CheatSheetSection title="Pro tips" icon="💡" color="blue">

- Use `--reload` during development for faster iteration
- Use `stdio` transport for Claude Desktop and Cursor
Expand All @@ -577,20 +579,19 @@ import '../../../cheat-sheet-print.css'

</CheatSheetSection>

<CheatSheetSection title="Typical Workflow" icon="📝" color="orange">
<CheatSheetSection title="Typical workflow" icon="📝" color="orange">
Standard development cycle for building MCP servers:

1. **`arcade login`** — Authenticate with Arcade Cloud
2. **`arcade new my_server`** — Create project (Minimal template)
3. **Edit `src/my_server/server.py`** — Add your tools
4. **`arcade mcp http --reload`** — Run locally with hot reload
5. **`arcade configure cursor`** — Connect your IDE
6. **Test tools 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
1. **`arcade login`**—Authenticate with Arcade Cloud
2. **`arcade new my_server`**—Create project (Minimal template)
3. **Edit `src/my_server/server.py`**—Add your tools
4. **`arcade mcp http --reload`**—Run locally with hot reload
5. **`arcade configure cursor`**—Connect your IDE
6. **Test tools in IDE**—Verify capability
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
</CheatSheetSection>

</CheatSheetGrid>

</CheatSheetGrid>