Browse docs

← All docs

docs / cix-install.md

cix install

Registers cix with your AI clients so they can reach the cix tools over the Model Context Protocol.

bash
$ cix install --client all

A plain cix install is client-safe: it wires the MCP server, session context, and editor integrations, and nothing else.

Flags

FlagWhat it does
--client CLIENTSWhich assistants to set up — claude, codex, gemini, cursor, or all. Comma-separated. Defaults to claude.
--guardrailsOpt into the enforcement profile: block the supported built-in write and edit tools on indexed files, and route reads toward the cix equivalents. Off by default.
--url URLPoint at a remote cix server instead of running one locally.
--devInternal development profile. Not needed for normal use.

Restart the client after installing so it loads the new configuration.

Choosing clients

shell
$ cix install --client claude,codex

An unrecognised name is rejected with the list of valid values, so a typo fails loudly instead of quietly setting up nothing. all expands to every supported client, and repeats are ignored.

One Cursor-specific note: Cursor loads hooks and tools only in directories you have trusted. In an untrusted folder cix is absent, not broken — trust the folder and it appears.

Guardrails

shell
$ cix install --guardrails

Guardrails steer your assistant to edit through the index rather than by string-matching through files. It is a routing and enforcement layer, not a sandbox — see Config and hooks for what it covers and how to suspend it locally.