Skip to content

auto-update(docs) - fix(ADK-607): Add adk ps to manage running dev servers #492

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
charmenta wants to merge 1 commit into from
Closed

auto-update(docs) - fix(ADK-607): Add adk ps to manage running dev servers #492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 2 additions & 41 deletions adk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ These flags work with every command:
| `--no-cache` | Disable caching for integration lookups |
| `--profile <profile>` | Credentials profile to use (overrides the `ADK_PROFILE` environment variable and the current profile) |

Most commands also accept `--format json` for machine-readable output. The following commands don't: `dev`, `login`, `profiles list`, `profiles set`, `upgrade`, `remove`, `self-upgrade`, `telemetry`, `theme`, `mcp`, `mcp:init`, `run`, `assets pull`.
Most commands also accept `--format json` for machine-readable output. The following commands don't: `dev`, `login`, `profiles list`, `profiles set`, `upgrade`, `remove`, `self-upgrade`, `telemetry`, `theme`, `mcp`, `mcp:init`, `run`, `assets pull`. `adk ps` supports `--format json` for single-shot output only; it can't be combined with `--watch`.

## Project

Expand Down Expand Up @@ -426,46 +426,7 @@ adk assets list --remote
| `--local` | Show only local assets |
| `--remote` | Show only remote assets |

## AI assistants

These commands integrate the ADK with AI coding tools:

| Command | Description |
|---------|-------------|
| `adk mcp` | Start the MCP server |
| `adk mcp:init` | Generate MCP configuration files |

### `adk mcp`

Start the MCP server so tools like Claude Code, Cursor, or VS Code can talk to your running dev server:

```bash
adk mcp
adk mcp --port 3001
```

| Flag | Description | Default |
|------|-------------|---------|
| `--cwd <path>` | Working directory for MCP operations | |
| `--port <port>` | UI server port to connect to | `3001` |

### `adk mcp:init`

Generate MCP configuration files for supported AI assistants:

```bash
adk mcp:init --all
adk mcp:init --tool claude-code
adk mcp:init --tool vscode cursor
```

| Flag | Description |
|------|-------------|
| `--tool <tool...>` | Specific tool(s): `claude-code`, `vscode`, `cursor` |
| `--all` | Generate for all supported tools |
| `--force` | Overwrite existing config |
| `--project-dir <path>` | ADK project subdirectory (for monorepos) |

## Utilities
## Account

These commands manage your Botpress credentials and the CLI itself:
Expand Down
Loading