Browse docs
Docs · for your AI assistant
The docs your assistant reads.
cix serves this reference to AI clients on demand through the get_docs tool — what each error code means, how freshness verdicts work, what the working-tree overlay is. The same content is published here, verbatim, so you can read exactly what your assistant reads.
concept-conventions
What repository conventions are, when they are checked, what a default install enforces versus a dev/guardrails install, and how opt-outs work.
The conventions model →concept-freshness-verdicts
How to read the effective_freshness block — verdict, source_used, canonical vs overlay status, and the assessment states that say whether a per-file check actually ran.
Freshness verdicts on read responses →concept-overlay
How cix serves your uncommitted work — what the overlay is, how it anchors to git state, and why refresh_stale and head-sha pinning exist.
The working-tree overlay →errors-access
What SUBSCRIPTION_INVALID, REPO_NOT_REGISTERED, QUOTA_EXCEEDED, INDEX_MISSING, TOOL_NOT_IN_TIER, CROSS_REPO_WRITE_REFUSED, PROJECT_NOT_LOCAL and PATH_OUTSIDE_REPO mean, and who can fix each.
Access, registration and quota errors →errors-conventions
What NO_RULES_DECLARED, CONVENTIONS_NOT_SYNCHRONIZED, CONVENTIONS_INVALID, UNKNOWN_KIND, UNSUPPORTED_LANGUAGE and UNIMPLEMENTED_RULE mean when check_convention cannot give a verdict.
Convention check errors and states →errors-freshness
What STALE_OVERLAY_REQUIRED, STALE_BYTES, STALE_INDEX, STALE_ANCHOR, INDEXED_SOURCE_MISMATCH and COMMITTED_NOT_PUSHED mean, and the recovery move for each.
Freshness and staleness errors →errors-resolution
What SYMBOL_NOT_FOUND, FILE_NOT_FOUND, MULTIPLE_MATCHES, AMBIGUOUS_MATCH, AMBIGUOUS_ANCHOR, OLD_TEXT_MISMATCH, DUPLICATE_SYMBOL and related codes mean when a lookup or edit cannot resolve its target.
Symbol and edit resolution errors →Looking for setup guides and workflows written for people? Head to the main docs.