CLI: setup and bootstrap
These commands create or refresh configuration. Run dry-runs first when a command supports them, especially inside an existing repository.
| Command | Writes | Purpose |
|---|---|---|
codifix wizard | Yes | Interactive global or project setup. |
codifix init | Yes | Non-interactive repo-local bootstrap. |
codifix demo | Yes | Load a disposable example project to try queries immediately. |
codifix tour | No | Walk through the core setup, query, and resume workflow. |
codifix upgrade | Yes | Refresh generated repo-local Codifix skill and instruction files. |
codifix completion | No | Print shell completion scripts. |
codifix dev | Mixed | Scaffold or inspect the dev-profile overlay used by contributors. |
codifix wizard
Use the wizard for first setup and for safe repo-local refreshes.
codifix wizard --global
cd /path/to/project
codifix wizard --project my-project --dry-run
codifix wizardThe global wizard stores machine-level settings such as the database URL, API token, and provider configuration. The project wizard writes a user-local project config plus repo-local .codifix/ and .agents/ files so agents can discover the project slug, Codifix rules, and skills.
codifix init
Use init when you want a scriptable project bootstrap instead of the interactive wizard.
codifix init
codifix init --project my-project --dry-run
codifix init --project my-project
codifix init --forcePrefer wizard for humans and init for repeatable repository setup. Both should be reviewed before committing generated files.
codifix demo and codifix tour
Use the demo when you want data to explore without first capturing your own work. Use the tour when you want a short, guided explanation of the core commands.
codifix demo
codifix tourThe demo is a reproducible learning path, not a replacement for initializing the repository where you will actually work.
codifix upgrade
Use upgrade after installing a newer Codifix version, especially when .agents/ skills or generated instructions changed.
codifix upgrade --dry-run
codifix upgrade --dry-run --json
codifix upgradeReal upgrade runs download the current Memory skill bundle from GitHub when possible and fall back to the installed skill-template when offline. Review generated diffs before committing. This command is expected to touch repo-local integration files, not the PostgreSQL database.
codifix completion
Generate shell completion for interactive use.
codifix completion bash
codifix completion zsh
codifix completion fishInstall the generated script according to your shell’s completion path.
codifix dev
The dev command is for contributors running Codifix from source. Use it to inspect or scaffold the dev-profile overlay instead of editing installed-user config.
codifix dev --help
codifix dev --copy-from-global
codifix dev --dry-run
CODIFIX_PROFILE=dev cargo run --bin codifix -- doctorThe dev profile keeps source-tree experimentation separate from the packaged
service. Cargo-run dev defaults use 127.0.0.1:4250 for HTTP and the /ws
WebSocket stream. The Cap'n Proto endpoints used before v2 no longer exist.