Quickstart

Get a Kumiko app running locally in under 5 minutes.

TL;DR

git clone git@github.com:CosmicDriftGameStudio/kumiko.git
cd kumiko
bun install
cp .env.example .env
bun kumiko dev

Open http://localhost:4444 — sample apps are reachable.

What just happened

Step	What it does
bun install	installs all workspace dependencies
cp .env.example .env	copies default dev config (DB credentials, ports)
bun kumiko dev	starts Docker services (PostgreSQL on :15432, Redis on :16379) and the dev server

Verify

bun kumiko status       # what's running on which port?
bun kumiko test         # changed unit tests
bun kumiko check        # Biome + TypeScript + tests

Next steps

• Build your first feature → see Patterns for the r.* API
• Look at samples/recipes/* for working examples
• Read Features and composition to understand the pipeline

Reset everything

bun kumiko reset        # nuke containers + DB, fresh start
bun kumiko stop         # stop services without deleting state