Reference
Files and directories
Codifix separates machine config, user-local project runtime state, and repo-owned agent files.
Installed and user-local locations
| Path | Purpose | Commit? |
|---|---|---|
/etc/codifix/codifix.toml | Debian/system global config. | No |
/etc/codifix/codifix.env | Debian/system env and service token file. | No |
~/.config/codifix/codifix.toml | Local Linux global config. | No |
~/.config/codifix/codifix.env | Local Linux global env file. | No |
~/.config/codifix/area-routing.json | Operator-owned area/instance routing. Never trust a repository copy. | No |
~/Library/Application Support/codifix/codifix.toml | macOS global config. | No |
~/.config/codifix/projects/<project-key>/config.toml | User-local project config. | No |
~/.config/codifix/projects/<project-key>/config.dev.toml | Dev-profile overlay for a source checkout. | No |
~/.local/state/codifix/projects/<project-key>/runtime/ | Linux project runtime state. | No |
~/.cache/codifix/projects/<project-key>/ | Linux project cache/index data. | No |
Platform-specific directories follow XDG on Linux and Application Support on macOS.
Area-specific offline queues, watcher state and audit paths include the area name and durable instance UUID. Changing the selected area does not migrate old queues. Native sync profiles and device credentials belong in protected user-local storage, outside repositories. See area routing and offline knowledge.
Repo-owned locations
| Path | Purpose | Commit? |
|---|---|---|
.codifix/project.toml | Project slug marker used by CLI and agents. | Usually yes |
.codifix/.gitignore | Keeps runtime/config secrets out while allowing project.toml. | Usually yes |
.codifix/config.toml | Legacy project config fallback. | Usually no for new repos |
.agents/codifix.toml | Agent-facing project behavior. | Usually yes |
.agents/skills/ | Repo-local Codifix skill bundle. | Usually yes |
docs/ | Markdown user/developer docs. | Yes |
docs-site/ | Fumadocs / Next.js website. | Yes |
web/ | Web UI source. | Yes |
Installed skill template
| Install mode | Template path |
|---|---|
| Debian package | /usr/share/codifix/skill-template/ |
| Local Linux install | ~/.local/share/codifix/skill-template/ |
| macOS package | /usr/local/share/codifix/skill-template/ |
| Homebrew | $(brew --prefix)/share/codifix/skill-template/ |
| Source/dev checkout | .agents/skills/ |
codifix wizard, codifix init, and codifix upgrade copy from this template into repo-local .agents/skills/.
Runtime checks
codifix doctor
codifix status --project <project-slug>
codifix service statusFor dev/source runs:
cargo run --bin codifix -- doctor
cargo run --bin codifix -- status --project <project-slug>Next
Read Project config.