Skip to content

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

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

Open
charmenta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

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
34 changes: 28 additions & 6 deletions adk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ These commands manage an agent project from scaffold to deploy:
| `adk deploy` | Deploy the agent to Botpress Cloud |
| `adk check` | Validate project structure and config (no login required) |
| `adk status` | Show project status, integrations, and server state |
| `adk ps` | List running ADK dev processes (DevConsole + connected agents) |
| `adk link` | Link local agent to a workspace and bot |

### `adk init`
Expand Down Expand Up @@ -58,14 +59,35 @@ adk dev
adk dev --port 3000 --port-console 3001
```

| Flag | Description |
|------|-------------|
| `-p, --port <port>` | Bot server port (default: `3000`) |
| `--port-console <port>` | Dev console port (default: `3001`) |
| `--otlp` | Enable OTLP export to external collector (port `4318`) |
| `--port-otlp <port>` | Override the OTLP collector endpoint port |
| `-v, --verbose` | Show additional details |
| `--non-interactive` | Emit structured NDJSON events to stdout |

### `adk ps`

List running ADK dev processes — the shared DevConsole and each connected `adk dev` session. Requires a DevConsole to be running (started by `adk dev` or `adk dashboard`):

```bash
adk ps
adk ps --wide
adk ps --watch
adk ps --watch 5
adk ps --format json
```

| Flag | Description | Default |
|------|-------------|---------|
| `-p, --port <port>` | Bot server port | `3000` |
| `--port-console <port>` | Dev console port | `3001` |
| `--otlp` | Enable OTLP export to external collector (port `4318`) | |
| `--port-otlp <port>` | Override the OTLP collector endpoint port | |
| `-v, --verbose` | Show additional details | |
| `--non-interactive` | Emit structured NDJSON events to stdout | |
| `--wide` | Show full paths, bot PIDs, and uptime | |

@github-actions github-actions Bot Jun 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'PIDs'?

| `--watch [seconds]` | Refresh the display every N seconds | `2` |
| `--no-header` | Omit the column header row | |

`--watch` cannot be combined with `--format json`.


### `adk deploy`

Expand Down
Loading