Browse docs

← All docs

docs / cli-config-and-hooks.md

Config and hooks

Per-project settings, and the optional enforcement that steers your assistant toward cix instead of letting it edit indexed files directly.

cix config

View or change settings for the current repository.

shell
$ cix config
FlagWhat it does
--repo PATHAct on a specific repo root instead of the current one
--jsonPrint the current settings as JSON
--guardEnable the pre-commit guard (the default)
--no-guardDisable it — the hook stays installed but exits quietly

The guardrails profile

Guardrails are an optional install profile. They are off unless you ask for them:

shell
$ cix install --guardrails

With guardrails on, the supported built-in write and edit tools are blocked on indexed files, and native reads and searches are routed toward the cix equivalents. The intent is that your assistant edits through the index — where it can target a symbol precisely — rather than string-matching its way through a file.

Heads — this constrains the supported built-in tools on indexed files within registered, reachable repositories. It is a routing and enforcement layer, not a sandbox: it does not stop every possible path to the filesystem. Treat it as steering, not containment.

Scope is deliberately narrow. Guardrails covers the editing and read-routing hooks; it does not install the broader internal-development profile.

Turning guardrails off temporarily

If a hook blocks something you need to do, there's a local bypass:

shell
$ cix hooks disable
SubcommandWhat it does
cix hooks disableSuspend cix hooks
cix hooks enableRestore them
cix hooks statusShow the current state

Note — the bypass is local to your machine and meant as an escape hatch. If a hook blocks you regularly, that's usually worth fixing rather than working around — a blocked edit often means the index is stale rather than that the edit is wrong.

Choosing which assistants to set up

Both cix install and cix init take --client, which accepts a comma-separated list — claude, codex, gemini, or all. It defaults to claude.

shell
$ cix install --client claude,codex

Next: Maintenance commands.