Skip to content

kindgi dev

Run the Kindgi runtime as a container + hot-reload the pack under cwd.

Terminal window
kindgi dev [--port <n>] [--database-url <url>] [--tenant <id>] [--dev-token <token>] [--no-watch] [--path <dir>] [--reset] [--recreate-services] [--runtime-image <ref> | --runtime-url <url>]

Flags:

  • --database-url <value>: The Postgres to use. Default: KINDGI_DATABASE_URL (the shell's, then the env files'), else the bundled Postgres.
  • --dev-token <value>: Pin the API token. Default: the previous run's (from .kindgirc.json), else a new one.
  • --no-watch: Start, index and register once, then exit. For smoke tests and CI.
  • --path <value>: The pack root, with a kindgi.config.ts or a pyproject.toml with [tool.kindgi]. Default: the current directory.
  • --port <value>: The port the runtime's API is reached on, on 127.0.0.1. Default: 4000. Not used with --runtime-url.
  • --recreate-services: Let docker compose recreate the bundled Postgres if its definition changed. By default an existing container is reused.
  • --reset: Start this pack fresh: removes .kindgirc.json, so the run gets a new tenant and token. The shared Postgres is left alone.
  • --runtime-image <value>: The runtime image to run. Default: the one this CLI release pins.
  • --runtime-url <value>: Use a runtime you run yourself, at this origin, instead of starting the container. Start it with the pack's .kindgi/dev/runtime.env.
  • --tenant <value>: Pin the tenant. Default: the previous run's (from .kindgirc.json), else a new one.
  • --watch: Re-index and reload the pack on every save. On by default; --no-watch turns it off.

Every command also takes the global flags.