Skip to content

Quick Start

This guide gets you running with a local Komand instance using Docker Compose.

  • Docker and Docker Compose v2+
  • 4 GB RAM minimum
Terminal window
git clone https://github.com/komand-ai/komand-server.git
cd komand-server
Terminal window
docker compose -f docker/docker-compose.yml up -d

This starts four services:

ServicePortPurpose
komand-postgres5432PostgreSQL 17 database
komand-seq5341Seq log viewer UI
komand-silo11111, 30000Orleans silo (grain host)
komand-gateway5000API gateway + web dashboard
Terminal window
curl http://localhost:5000/health

You should get:

{ "success": true, "data": { "status": "healthy" } }
Terminal window
curl -X POST http://localhost:5000/api/webchat/message \
-H "Content-Type: application/json" \
-d '{
"senderId": "user-1",
"text": "Hello, Komand!",
"displayName": "Alice"
}'

This sends a message through the WebChat channel adapter. The default agent will process it and return a response.

Navigate to http://localhost:5000 in your browser to access the web dashboard.

Open the Seq log viewer at http://localhost:5341 to see structured logs from all services.

For local development without PostgreSQL, set the environment to Development:

Terminal window
DOTNET_ENVIRONMENT=Development

In development mode, Komand uses:

  • In-memory grain storage (no database required)
  • Localhost clustering (single-node)
  • In-memory reminder service
  • Swagger UI at /swagger