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 docker database startup by running:

pnpm setup-dev --skip-docker

Make sure your DATABASE_URL environment variable is configured for your cloud database.

Step 3: Launch the dev environment

pnpm dev

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

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

• 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.
• Install the Inkeep MCP in your IDE to enable AI coding assistants to "vibe code" your Inkeep agents.