Skip to main content
This guide walks you through installing the ADK and creating your first agent project.
You will need:

​
Installation

Install the ADK CLI globally:
Verify the installation:

​
Create your first agent

Initialize a new agent project:
Select the Hello World template, then follow the prompts to set up the agent. This creates a new my-agent directory with:
  • agent.config.ts - Agent configuration and integration dependencies
  • agent.json - Configuration for your linked bot
  • package.json - Project configuration
  • tsconfig.json - TypeScript configuration
  • src/ - Source code directory structure

​
Install dependencies

Once you’ve finished the setup, navigate into your project:
Install the dependencies:

​
Test your agent

Now, you’re ready to test your agent.

​
Start the development server

Start the development server with hot reloading:
This command:
  1. Generates TypeScript types for your integrations
  2. Builds your agent
  3. Starts a local development server
  4. Watches for file changes and automatically rebuilds

​
Chat in the terminal

Open a new terminal window and start a conversation with your agent:

​
View the ADK console

Visit http://localhost:3001/ to access the interactive ADK console. This gives you an intuitive, visual breakdown of your agent project and lets you configure its integration’s settings.

​
Build your agent

Compile your agent for production:
This creates an optimized build in the .adk/bot/.botpress/dist directory.

​
Deploy your agent

When you’re ready, you can deploy your agent to Botpress Cloud:
This uploads your agent to your Botpress workspace and makes it available for use.
You deployed your first agent using the ADK!

​
Next steps

Project Structure

Learn about ADK project organization

Conversations

Create your first conversation handler