Skip to content

feat(adk): doc context and adk apis #404

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

Merged
adkah merged 1 commit into from
Jan 27, 2026
Merged

feat(adk): doc context and adk apis #404

Show file tree
Hide file tree
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
68 changes: 66 additions & 2 deletions adk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ adk add webchat --alias custom-webchat

### `adk chat`

Chat with your deployed bot directly from the CLI.
Chat with your agent in development mode directly from the CLI.

**Usage:**
```bash
Expand All @@ -140,6 +140,62 @@ Run `adk dev` first to create a development bot if you don't have a `devId` in y

---

### `adk run`

Run a TypeScript script with the ADK runtime fully initialized. This allows you to execute scripts that use your agent's primitives, integrations, and runtime utilities like `client`, `context`, and `adk`.

**Usage:**
```bash
adk run <script> [args...]
adk run scripts/migrate-data.ts
adk run scripts/seed-tables.ts --prod
adk run scripts/analyze.ts arg1 arg2
```

**Arguments:**

| Argument | Description |
|----------|-------------|
| `script` | Path to the TypeScript script file to run |
| `args` | Optional arguments to pass to the script |

**Flags:**

| Flag | Description | Default |
|------|-------------|---------|
| `-f, --force` | Force regeneration of the bot project | `false` |
| `--prod` | Use production bot instead of dev bot | `false` |

**Script exports:**

Your script can export a function that will be called automatically:

```typescript
// Option 1: Default export
export default async function(arg1: string, arg2: string) {
// Script logic
}

// Option 2: Named 'run' export
export async function run(arg1: string, arg2: string) {
// Script logic
}

// Option 3: Named 'main' export
export async function main(arg1: string, arg2: string) {
// Script logic
}

// Option 4: Top-level code (runs on import)
console.log("Script executed!")
```

<Tip>
Use `adk run` to execute migrations, seed data, run maintenance tasks, or any script that needs access to your agent's runtime context.
</Tip>

---

### `adk mcp`

Start an MCP (Model Context Protocol) server for AI assistant integration. This allows AI coding assistants like Claude Code and Cursor to interact with your ADK agent.
Expand Down Expand Up @@ -373,13 +429,21 @@ adk link --workspace <workspaceId> --bot <botId> --dev <devBotId>

### `adk self-upgrade`

Upgrade ADK CLI to the latest version.
Upgrade ADK CLI to the latest version or a specific version/tag.

**Usage:**
```bash
adk self-upgrade
adk self-upgrade beta
adk self-upgrade 1.13.0
```

**Arguments:**

| Argument | Description |
|----------|-------------|
| `tag-or-version` | Optional. Tag (`beta`, `next`) or specific version (`1.13.0`) to install |

**Aliases:** `self-update`

---
Expand Down
Loading