Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
fc8b1df
remove default expand
adkah Apr 22, 2026
22537f7
align get started section
adkah Apr 22, 2026
95a4146
audit configuration guide
adkah Apr 22, 2026
ceb76bc
quick fix to quickstart description
adkah Apr 22, 2026
ce64b70
audit environment setup guide
adkah Apr 22, 2026
7be95f4
audit integrations
adkah Apr 22, 2026
828d32a
audit conversations/setup
adkah Apr 22, 2026
7c115c6
audit ai execution guide
adkah Apr 23, 2026
bd96ad6
revert next steps sections
adkah Apr 23, 2026
6994579
audit tools page
adkah Apr 23, 2026
e690a65
audit custom components
adkah Apr 23, 2026
ec8dde0
audit messages
adkah Apr 23, 2026
971c59c
Merge remote-tracking branch 'origin/aj/adk-docs-update' into ak-aj-a…
adkah Apr 23, 2026
2d81070
audit lifecycle and state
adkah Apr 23, 2026
0eb4d41
audit steps
adkah Apr 23, 2026
75f5a1c
audit request/notify
adkah Apr 23, 2026
1fcf758
audit actions
adkah Apr 24, 2026
7f0a595
fix actions description
adkah Apr 24, 2026
cf17191
audit triggers
adkah Apr 24, 2026
f631f13
audit tables
adkah Apr 24, 2026
87d3796
fix
adkah Apr 24, 2026
bc1cca1
fix vale
adkah Apr 24, 2026
b0c8c69
fix vale again
adkah Apr 24, 2026
a6999e2
add redirects
adkah Apr 24, 2026
0ed3fe9
fix links
adkah Apr 24, 2026
24108a9
audit knowledge
adkah Apr 24, 2026
60b34ff
fix kb description
adkah Apr 24, 2026
ee716ba
fix
adkah Apr 24, 2026
8df10ff
docs(adk): fix accuracy issues from PR audit
jacksonyzj Apr 24, 2026
ae308cb
docs(adk): fix accuracy issues surfaced by end-to-end testing
jacksonyzj Apr 24, 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
94 changes: 0 additions & 94 deletions adk/get-started/quickstart.mdx

This file was deleted.

17 changes: 9 additions & 8 deletions adk/get-started/welcome.mdx → adk/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: Botpress ADK
sidebarTitle: Welcome
description: The Botpress Agent Development Kit (ADK) is a developer-first TypeScript framework for building AI agents on the Botpress Platform.
title: Introduction to the ADK
description: TypeScript framework for building AI agents on Botpress.
---

The Agent Development Kit (ADK) is a **CLI tool and development framework for building AI agents on Botpress**. It provides a streamlined development experience with TypeScript support, hot reloading, and type-safe APIs for creating AI applications.

You write conversations, workflows, tools, and actions as code. Botpress handles hosting, scaling, and channel delivery.

<Frame>
<img alt="Botpress ADK" className="block dark:hidden" src="../assets/welcome.png" />
<img alt="Botpress ADK" className="hidden dark:block" src="../assets/welcome-dark.png" />
<img alt="Botpress ADK" className="block dark:hidden" src="./assets/welcome.png" />
<img alt="Botpress ADK" className="hidden dark:block" src="./assets/welcome-dark.png" />
</Frame>

The ADK is a TypeScript framework for building AI agents that run on the Botpress Platform. You write conversations, workflows, tools, and actions as code. The platform handles hosting, scaling, and channel delivery.

## What you can build

- **Customer support agents** that resolve tickets, look up orders, and escalate to humans
Expand Down Expand Up @@ -46,7 +47,7 @@ Each primitive lives in its own file under `src/`. The ADK discovers them automa
## Start here

<CardGroup cols={2}>
<Card title="Quickstart" icon="rocket" href="/adk/get-started/quickstart">
<Card title="Quickstart" icon="rocket" href="/adk/quickstart">
Install the ADK and deploy your first agent in minutes.
</Card>
<Card title="What's new" icon="newspaper" href="/changelog">
Expand Down
138 changes: 138 additions & 0 deletions adk/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
title: Quickstart
description: This guide walks you through installing the ADK and creating your first agent project.
---

By the end of this guide, you'll have a working AI agent that responds to messages on Webchat. It takes about 5 minutes.

<Info>
You will need:

* A [Botpress account](https://sso.botpress.cloud)
* [Node.js](https://nodejs.org/en) (v22.0.0 or higher)
* A supported package manager — [bun](https://bun.sh), [pnpm](https://pnpm.io), [yarn](https://yarnpkg.com) or [npm](https://www.npmjs.com)
</Info>

## Installation

Install the ADK CLI globally:

<CodeGroup>
```bash macOS & Linux theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
curl -fsSL https://github.com/botpress/adk/releases/latest/download/install.sh | bash
```

```powershell Windows (PowerShell) theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
powershell -c "irm https://github.com/botpress/adk/releases/latest/download/install.ps1 | iex"
```
</CodeGroup>

Then, verify the installation:

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
adk --version
```

Log in to your Botpress account:

```bash
adk login
```

This will open a browser window for authentication. Once complete, the CLI stores your credentials locally.

## Create your agent

Initialize a new agent project:

```bash
adk init my-agent
```

The wizard walks you through three steps:

1. **Select a template**: Pick `hello-world`. This creates a simple agent that responds to webchat messages using an AI model.
2. **Select a package manager**: We recommend [bun](https://bun.sh) for the fastest experience. npm, pnpm, and yarn also work. If you only have one installed, this step is skipped.
3. **Link to Botpress**: Select the workspace you want to deploy to. The CLI creates a bot in that workspace and connects your project to it.

The CLI then automatically installs dependencies and sets up your project in the `my-agent` directory.

Navigate into your project:

```bash
cd my-agent
```

## Test your agent

Now, you’re ready to test your agent.

### Start the development server

Start the development server with hot reloading:

```bash
adk dev
```

This builds your agent, deploys it to a development bot on Botpress, and starts the dev console at [`http://localhost:3001/`](http://localhost:3001/). Press <kbd>space</kbd> in the terminal to open it in your browser.

### View in the dev console

The dev console is your local control panel for building and debugging. Within the dev console, you can:

- Chat with your agent
- Browse its components (actions, workflows, triggers)
- Manage data (tables, knowledge bases, files)
- Run evals
Comment thread
adkah marked this conversation as resolved.
- Inspect traces and logs
- Configure integrations

Go to the **Chat** page and send a message to test your agent:

<Frame>
<img alt="ADK dev console" className="block dark:hidden" src="./assets/quickstart.png" />
<img alt="ADK dev console" className="hidden dark:block" src="./assets/quickstart-dark.png" />
</Frame>

The dev server watches your files and rebuilds on every change.

### Chat in the terminal

Alternatively, open a new terminal window and start a conversation with your agent from the command line:

```bash
adk chat
```

```txt
Botpress Chat
Type "exit" or press ESC key to quit
👤 Hey!
🤖 Hello! How can I assist you today?
>>
```

## Deploy your agent

When you're ready to go live:

```bash
adk deploy
```

This builds your agent for production, runs preflight checks (integration changes, config diffs), syncs your knowledge bases and tables, and uploads everything to Botpress. The CLI walks you through any changes that need approval before deploying.

Once deployed, your agent is live in the workspace you linked during `adk init`.

<Check>
You deployed your first agent using the ADK!
</Check>

## Next steps

Next, learn what's in the project you just created and how to configure it:

<Card title="Agent configuration" icon="settings" href="/adk/setup/configuration">
Project structure, models, state, and dependencies.
</Card>
20 changes: 2 additions & 18 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,10 @@
"group": "ADK",
"tag": "Beta",
"pages": [
{
"group": "Get Started",
"expanded": true,
"pages": [
"/adk/get-started/welcome",
"/adk/get-started/quickstart"
]
},
"/adk/introduction",
"/adk/quickstart",
{
"group": "Setting up your agent",
"expanded": true,
"pages": [
"/adk/setup/configuration",
"/adk/setup/environment",
Expand All @@ -108,7 +101,6 @@
},
{
"group": "Handling conversations",
"expanded": true,
"pages": [
"/adk/conversations/setup",
"/adk/conversations/ai-execution",
Expand All @@ -121,7 +113,6 @@
},
{
"group": "Handling longform logic",
"expanded": true,
"pages": [
"/adk/workflows/create",
"/adk/workflows/steps",
Expand All @@ -130,23 +121,20 @@
},
{
"group": "Actions and triggers",
"expanded": true,
"pages": [
"/adk/external/actions",
"/adk/external/triggers"
]
},
{
"group": "Working with data",
"expanded": true,
"pages": [
"/adk/data/tables",
"/adk/data/knowledge"
]
},
{
"group": "Testing and debugging",
"expanded": true,
"pages": [
"/adk/testing/evals",
"/adk/testing/agent-steps",
Expand All @@ -156,7 +144,6 @@
},
{
"group": "LLM Utilities",
"expanded": true,
"pages": [
"/adk/zai/overview",
"/adk/zai/extract",
Expand All @@ -166,21 +153,18 @@
},
{
"group": "AI Native Development",
"expanded": true,
"pages": [
"/adk/ai-native/skills"
]
},
{
"group": "Advanced",
"expanded": true,
"pages": [
"/adk/advanced/hitl"
]
},
{
"group": "CLI",
"expanded": true,
"pages": [
"/adk/cli-reference"
]
Expand Down
2 changes: 1 addition & 1 deletion index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import { IntegrationsCard } from '/home-components/IntegrationsCard.jsx'
title="ADK"
img='/homepage-assets/adk.jpg'
cta="Get started"
href="/adk/get-started/welcome"
href="/adk/introduction"
>
TypeScript library for building AI agents from code <Badge color="blue">Beta</Badge>
</Card>
Expand Down
Loading