Cogitator
Getting Started

Project Scaffolding

Create new Cogitator projects in seconds with create-cogitator-app.

create-cogitator-app is an interactive CLI that scaffolds production-ready Cogitator projects with your chosen template, LLM provider, and tooling.

Quick Start

npx create-cogitator-app

This launches an interactive prompt that guides you through:

  1. Project name and location
  2. Template selection
  3. LLM provider
  4. Package manager
  5. Docker Compose and git options

Templates

TemplateBest For
basicGetting started, single agent with tools
memoryAgents that need cross-session memory (Redis)
swarmMulti-agent hierarchical task delegation
workflowDAG pipelines with sequential agent nodes
api-serverREST API backends with Express
nextjsFull-stack chat apps with streaming UI

CLI Flags

Skip the prompts by passing flags directly:

npx create-cogitator-app my-project \
  --template swarm \
  --provider openai \
  --pm pnpm \
  --docker \
  --no-git
FlagShorthandValues
--template-tbasic, memory, swarm, workflow, api-server, nextjs
--provider-pollama, openai, anthropic, google
--pmpnpm, npm, yarn, bun
--docker / --no-dockerInclude Docker Compose (Redis, Postgres)
--git / --no-gitInitialize git repository

Providers

ProviderDefault ModelEnv Var
ollamaqwen2.5:7bOLLAMA_BASE_URL (optional)
openaigpt-4oOPENAI_API_KEY
anthropicclaude-sonnet-4-20250514ANTHROPIC_API_KEY
googlegemini-2.5-flashGOOGLE_API_KEY

Generated Structure

my-project/
├── src/
│   ├── index.ts        # Entry point
│   └── tools.ts        # Tool definitions
├── package.json
├── tsconfig.json
├── cogitator.yml       # Provider config
├── .env.example
├── .gitignore
└── README.md

Docker Compose (when --docker) adds docker-compose.yml with Redis and Postgres services.

Programmatic API

import { scaffold } from 'create-cogitator-app';

await scaffold({
  name: 'my-agent',
  path: '/projects/my-agent',
  template: 'basic',
  provider: 'ollama',
  packageManager: 'pnpm',
  docker: false,
  git: true,
});

On this page