Docs Navigation
Docs/Reference

CLI Reference

Every kolmos subcommand and the most important flags for each.

Last Updated: August 2026

1. Global Flags

These apply before the subcommand, on the root `kolmos` command: - `--root <dir>` (default `.`) — store root directory - `--store {local,s3}` (default `local`) - `--s3-bucket`, `--s3-region` (default `us-east-1`), `--s3-endpoint`, `--s3-access-key-id`, `--s3-secret-key` (env fallback `KOLMOS_S3_SECRET_KEY`), `--s3-prefix` (default `""`), `--s3-force-path-style`

bashKOLMOS Reference
kolmos --root /data --store s3 --s3-bucket kolmos-prod --s3-region auto <subcommand> ...

2. Subcommands

`ingest`, `query`, `serve`, `export`, `stats`, `explain-report`, `analyze`, `compact`, `vacuum`, `workload compile`, `verify`, `backup`, `restore`, `backup-log`, `derive`, `pg-ingest`, `mysql-ingest`, `mongo-ingest`, `demote`, `promote`, `demotion-policy {set,get,clear}`. See the Backup & Disaster Recovery guide for `backup`/`restore`/`backup-log`, and the storage guide for `compact`/`vacuum`/`demote`/`promote`.

3. serve — Full Flag Reference

The most commonly used flags for the long-running server process: - `--host` (default `127.0.0.1`), `--port` (default `5432`, Postgres wire) - `--username` (default `kolmos`), `--password` (env `KOLMOS_SERVE_PASSWORD`), `--auth-file <path>` - `--mysql-port`, `--mongo-port` — opt-in additional wire listeners - `--multi-store`, `--api-port`, `--api-token` (env `KOLMOS_API_TOKEN`), `--max-open-stores` (default `32`), `--idle-timeout-secs` (default `1800`) - `--tls-cert`, `--tls-key` - `--metrics-port`, `--log-format {text,json}` (default `text`) - `--vacuum-interval-secs` (default `300`, `0` disables), `--refresh-interval-secs` (default `5`, `0` disables — HA read-refresh worker)

bashKOLMOS Reference
kolmos --root /data serve --host 0.0.0.0 --port 5432 \
  --mysql-port 3306 --mongo-port 27017 \
  --tls-cert /certs/server.crt --tls-key /certs/server.key \
  --username kolmos --auth-file /auth.txt \
  --metrics-port 9090 --log-format json