Quickstart

Let’s get set up with a quick hello-world agent built with the ADK.

You’ll need Node.js 22.0.0 or higher and a Botpress account to log in with.

1. Install the ADK CLI

   Run the install command for your operating system:

   macOS & Linux

   curl -fsSL https://github.com/botpress/adk/releases/latest/download/install.sh | bash
   

   Windows (PowerShell)

   powershell -c "irm https://github.com/botpress/adk/releases/latest/download/install.ps1 | iex"
   

   Open a new terminal and verify the installation:

   adk --version
   
2. Log in to Botpress

   Authenticate with your Botpress account:

   adk login
   

   Follow the prompts to sign in through your browser. The CLI saves your credentials for every command that follows.

3. Create a project

   Scaffold a new project:

   adk init my-agent
   cd my-agent
   

   Pick the hello-world template when prompted. The wizard also asks for a package manager and a Botpress workspace to link the project to.

4. Run your agent locally

   Start the dev server:

   adk dev
   

   Open the dev console at http://localhost:3001 and head to the Chat page to talk to your agent.

   
5. Deploy to Botpress Cloud

   Ship your agent:

   adk deploy
   

   This builds a production bundle and uploads it to the workspace you linked during adk init. Chat with your live agent from your Botpress Cloud workspace.

Next steps

Project structure

See what an ADK project looks like.

Build with a coding assistant

Pair the ADK with Claude Code, Cursor, or Codex using ADK skills.