Create an Inkeep Agent Framework project
npm install @inkeep/create-agentsBefore 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:
``bash`
node --version
pnpm --version
docker --version
Run the quickstart script on a target folder:
`bash`
npx @inkeep/create-agents my-agents
Navigate to the folder
`bash`
cd my-agents
Open the folder using your coding editor. To open with Cursor, you can run cursor .
Ensure Docker Desktop (or Docker daemon) is running before running the setup script.
`bash`
pnpm setup-dev
Or if you are using a cloud database, you can skip the docker database startup by running:
`bash`
pnpm setup-dev --skip-docker
Make sure your DATABASE_URL environment variable is configured for your cloud database.
`bash`
pnpm dev
The Visual Builder will auto-open at http://localhost:3000.
Navigate to the Activities Planner agent at http://localhost:3000 and ask about fun activities at a location of your choice:
- 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.