Quick start

Quick Start

Copy page

Start developing your agents with the Inkeep Agent Platform

Prerequisites

  • Node.js 22+
  • Docker (installation instructions here)
  • pnpm 10+ (installation instructions here)

Step 1: Create a new agents project

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

Step 2: Run the setup script

pnpm setup-dev

Step 3: Launch the development environment

pnpm dev

The Visual Builder will open automatically at http://localhost:3000.

Service Ports

The development environment starts multiple services on different ports:

ServicePortURLDescription
Visual Builder3000http://localhost:3000Web interface for building and managing agents
Manage API3002http://localhost:3002API for managing agent configurations and projects
Run API3003http://localhost:3003API for executing agent conversations with your agents
Note
Note

Make sure these ports are available before starting the development environment. If any port is in use, you'll need to free it up first.

Step 3: Install the Inkeep CLI

npm install -g @inkeep/agents-cli

Step 4: Push your project

Running this command will push the code you defined your agents and tools with to the Visual Builder.

cd src/weather-project
inkeep push

Step 5: Chat with your agent

Open the Visual Builder at http://localhost:3000, click into the weather graph, and then click the "Try It" button to start chatting with the agent.

Next, we recommend setting up observability to see live traces of your agent. See Traces for more information.