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
• Docker
• pnpm version 10 or higher

You can verify by running:

node --version
pnpm --version
docker --version

Step 1: Create a new agents project

Run the quickstart script on a target folder:

npx @inkeep/create-agents my-agents

Navigate to the folder

cd my-agents

Open the folder using your coding editor. To open with Cursor, you can run cursor .

Step 2: Run the setup script

Ensure Docker Desktop (or Docker daemon) is running before running the setup script.

pnpm setup-dev

Or if you are using a cloud database, you can skip the local Docker database startup by running:

pnpm setup-dev:cloud

Make sure your INKEEP_AGENTS_MANAGE_DATABASE_URL and INKEEP_AGENTS_RUN_DATABASE_URL environment variables are configured in .env for your cloud databases.

Step 3: Launch the dev environment

pnpm dev

The Visual Builder will auto-open at http://localhost:3000. You'll be signed in automatically.

Step 4: Chat with your agent

Navigate to the Activities Planner agent at http://localhost:3000 and ask about fun activities at a location of your choice:

Next steps

• Set up AI coding for Inkeep with skills and MCP.
• Learn about inkeep push / pull so you can go from SDK -> Visual Builder and Visual Builder -> SDK.
• Follow our meeting prep agent tutorial to create an agent using the Visual Builder.
• Follow our fact finder agent tutorial to create an agent using the TypeScript SDK.