CODI / Docs

Documentation

Everything needed to install, run, extend, and audit CODI. Start with the overview if you are new, or jump straight to the reference you need.

Getting started

Overview

What CODI does, the capabilities it ships, and who it is for.

Read

Installation

Prerequisites, setup, environment variables, and troubleshooting.

Read

Quick reference

A cheat sheet for commands, environment variables, and make targets.

Read

Architecture

System architecture

Module-by-module design, data flow, and deployment models.

Read

Technology stack

Every dependency and tool CODI is built on, and why.

Read

Using CODI

CLI guide

Each command in depth, with flags, output, and worked examples.

Read

API guide

The FastAPI service: endpoints, schemas, and integration notes.

Read

Slim container

Run the deterministic rules engine in CI or a disconnected stage.

Read

Complete container

Add the embedded local model for ranking and written rationales.

Read

Components

Rules & templates

How the rules catalog works and how to add rules or a new stack.

Read

Reporting

The artifacts every run produces and how to aggregate them.

Read

LLM module

Adapter lifecycle, the local runtime, telemetry, and evaluation.

Read

Operating CODI

Operations

Day-two runbooks, monitoring, and routine maintenance.

Read

Security model

Air-gap enforcement, allowlists, container hardening, and provenance.

Read

Performance

Budgets, the measurement harness, and how to read the numbers.

Read

Reference

Reference manual

Command and API reference, file formats, and the glossary.

Read

Questions? Get in touch. Source on GitHub