| Command | Description | piko new | Create a new Piko project through the interactive wizard. |
piko generate | Generate assets and the manifest, equivalent to go run ./cmd/generator all. Accepts an optional mode argument: all (default), manifest, assets, or sql. |
piko build | Generate then compile a self-contained production binary. Flags: --output/-o (binary path, default bin/app), --mode (generate mode, default all), --no-embed (build a binary that serves dist/ and .piko/ from disk instead of embedding them). |
piko dev | Generate assets then run the development server, equivalent to go run ./cmd/generator all && go run ./cmd/main dev. |
piko dev-i | Generate assets then run the development server in interpreted mode, equivalent to go run ./cmd/generator all && go run ./cmd/main dev-i. Requires a project scaffolded with interpreted mode. |
piko fmt | Format .pk template files. Flags: -w (write, default true), -r (recurse), -n (dry run), --check (exit 1 if any files need formatting), -l (list files needing formatting). Accepts file or directory arguments. |
piko extract <subcommand> | Extract Go package symbols for the bytecode interpreter. Subcommands: init (write a starter extract.yaml), discover (find packages used by the project), generate (run extraction and emit the descriptor), check (verify the descriptor is up to date). Run piko extract <subcommand> --help for flags. |
piko inspect <type> <file> | Inspect FlatBuffers binary files. Types: manifest, i18n, collection, search, bytecode, wal. WAL-only flags: --effective (final state per key after replay), --parse-values (parse JSON string values into native objects). All types accept --compact for compact JSON. |
piko bytecode <file.go> [flags] | Compile a Go file to Piko bytecode and inspect or save it. Flags: --types <descriptor> (path to gen_types_descriptor.json), --save <output> (write the compiled .bin instead of printing JSON inspection), --asm (print human-readable bytecode assembly in .pkasm format), --compact (compact JSON output instead of pretty-printed). Without --save or --asm the command prints the bytecode as JSON. |
piko agents | Configure AI coding tools with Piko knowledge (Claude Code, Codex, Cursor, etc.). |
piko profile <url> | Profile a live server under load: CPU, memory, mutex, and blocking profiles. Supports --focus to scope results. See how to profiling for interpretation. |
| Command | Description | piko get <resource> | Display a resource: health, tasks, workflows, artefacts, variants, metrics, traces, resources, dlq, ratelimiter. |
piko describe <resource> [id] | Show detailed information for one resource entry. Resources: health, task, trace, workflow, artefact, dlq, resources, ratelimiter, provider, providers. Note: describe uses singular resource names (task, trace, workflow, artefact) where get uses plurals. |
piko info [area] | Display system information. Areas: system, build, runtime, memory, gc, process. |
piko watch <resource> | Stream resource updates in real time. Supports --interval (default 2s). |
piko profiling enable <duration> | Enable on-demand profiling for a window. |
piko profiling status | Report whether profiling is active. |
piko profiling capture <kind> [duration] | Capture a specific profile: heap, cpu, goroutine, mutex, block, allocs, trace. |
piko profiling disable | Disable on-demand profiling. |
piko diagnostics | Test connectivity to the monitoring server. |
piko tui | Launch the interactive terminal UI. |
piko watchdog status | Print the watchdog's lifecycle, thresholds, and continuous-profiling configuration. |
piko watchdog list [--type <t>] | List stored watchdog profiles. |
piko watchdog download [<file> | --latest --type <t>] | Download a stored profile (and its sidecar JSON) to a local directory. |
piko watchdog prune [--type <t>] | Remove stored watchdog profiles. |
piko watchdog history | Print the startup-history ring; an unclean stop indicates a crash. |
piko watchdog events [--since <d>] [--type <t>] [--tail] | List or stream watchdog events from the in-memory ring. |
piko watchdog contention-diagnostic | Run a one-shot block and mutex contention diagnostic. |