Quick Start

Launch your first agent

Prerequisites

Before getting started, ensure you have the following installed on your system:

• Node.js version 22 or higher
• pnpm version 10 or higher

You can verify your installations by running:

node --version
pnpm --version

Step 1: Create a new agents project

First, create a new agents project.

npx @inkeep/create-agents my-agent-directory 

Navigate to the new agents project.

cd my-agent-directory

Step 2: Launch the dev environment

pnpm dev

The Visual Builder automatically opens at http://localhost:3000.

Step 3: Chat with your agent

Navigate to the Event Planner agent at http://localhost:3000, click Try it, and ask about fun activities at a location of your choice.

Next steps

Next, we recommend learning about inkeep push and inkeep pull so you can go from SDK -> Visual Builder and Visual Builder -> SDK. See the Push / Pull guide for a quick example.