Skip to content

kumiko doctor

Terminal window
kumiko doctor

Walks through a checklist and prints ✓ or ✗ for each item, with an actionable hint when something is missing.

CheckHint when failing
.env file existscp .env.example .env
Required env vars setshows the missing names
node_modules/ existsbun install
Docker services runningkumiko dev
Postgres accepts connectionsdocker compose logs postgres

Required env vars currently include DATABASE_URL, TEST_DATABASE_URL, REDIS_URL, MEILI_URL, MEILI_MASTER_KEY, JWT_SECRET.

  • After cloning the repo, before doing anything else
  • When something behaves weirdly and you want to rule out env drift
  • Before reporting a bug, paste the doctor output

0 when everything is green. 1 when at least one check failed, useful in CI sanity-check jobs or pre-task scripts.