CODI Deprecation Notice & Legacy Mapping
This notice documents how the latest CODI deliverable supersedes the earlier hackathon drop. Use it to locate the modern equivalent for any legacy instructions or scripts you encounter in internal wikis.
Legacy→Current Documentation Map
| Legacy Asset | Current Replacement | Notes |
|---|---|---|
legacy/README.md |
INTRODUCTION.md |
Overview rewritten to highlight personas, capabilities, and audit guarantees. |
legacy/INSTALL.md |
INSTALLATION.md |
Expanded prerequisites, environment variables, and troubleshooting paths for CI. |
legacy/quickstart.md |
QUICK_REFERENCE.md |
Daily cheat sheet now aligned with CLI + API parity. |
legacy/cli.md |
CLI_GUIDE.md |
Deep dive reorganised around workflows (analyze, rewrite, run, report). |
legacy/rules.md |
RULES_GUIDE.md |
Deterministic templates now reference the shared patterns/rules.yml catalog. |
legacy/container.md |
SLIM_CONTAINER.md, COMPLETE_CONTAINER.md |
Split to isolate rules-only and LLM-enabled guidance. |
legacy/llm.md |
LLM_MODULE.md |
Adapter lifecycle, telemetry schema, and evaluation harness extended. |
legacy/security.md |
SECURITY.md |
Air-gap posture, allowlists, and compliance artefacts formalised. |
legacy/perf.md |
PERFORMANCE.md |
Incorporates codi perf harness, budgets, and regression gates. |
legacy/ops.md |
OPERATIONS.md, CICD_RELEASE.md |
Day-2 procedures separated from release automation. |
Deprecated CLI Flags
| Removed Flag | Replacement | Rationale |
|---|---|---|
--rules-dir |
--rules-catalog / RULES_PATH |
Unified rules catalog path used by both CLI and API. |
--no-airgap |
AIRGAP=false |
Environment variable now controls outbound policy consistently. |
--llm |
--enable-llm / LLM_ENABLED=true |
Makes intent explicit and matches container defaults. |
Upgrade Checklist
- Re-align scripts to use
codi run,codi report, orcodi allinstead of bespoke pipelines. - Update container orchestration to target
codi:slimorcodi:completeimages and mount adapters under/models. - Refresh dashboards to ingest the new
runs/<timestamp>/reports/*.jsonartefacts documented inREPORTING.md. - Replace any manual rule patches with contributions through the
RULES_GUIDE.mdworkflow.
Support Window
Legacy artefacts remain readable but will not receive new features. Please file migration questions under the "Deprecations" label referenced in CONTRIBUTING.md.
Related Docs
- INDEX.md for the full navigation surface.
- OPERATIONS.md for runbook updates triggered by these deprecations.
- REFERENCE.md when auditing schema-level deltas.