Skip to content

Commit 7ff2b84

Browse files
committed
docs: add coven CLI unification plan (phases 0-6)
The full phased plan behind the engine-contract work and coven#346. Phase 0 (contract) and Phase 1 (singular entry point) are implemented; phases 2-6 are specified to interface level here.
1 parent dc40d25 commit 7ff2b84

3 files changed

Lines changed: 1061 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Agent-facing rules for working on Coven Code. Mirrors and extends `src-rust/.cla
2626
- NEVER modify generated files directly. Generated artefacts in this repo:
2727
- `src-rust/Cargo.lock` — regenerated by cargo; for version bumps use [`scripts/bump-version.py`](scripts/bump-version.py).
2828
- `npm/package.json` `version` field — also stamped by `bump-version.py`.
29+
- Contract surfaces (see COVEN.md "Engine contract") are semver-guarded — breaking them requires a contract version bump.
2930

3031
## Commands
3132

COVEN.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,17 @@ Add Coven-specific tools (e.g. `coven_session_tool.rs`) and register in `tools/s
100100

101101
---
102102

103+
## Engine contract
104+
105+
coven-code is the engine behind the unified `coven` CLI. The exact CLI/env/
106+
stream surfaces coven depends on are specified in
107+
[coven/docs/ENGINE-CONTRACT.md](https://github.com/OpenCoven/coven/blob/main/docs/ENGINE-CONTRACT.md)
108+
(`contract_version: 1`). Do not change flags, output formats, or exit codes
109+
listed there without bumping the contract version and coordinating a coven
110+
`engine.lock` update.
111+
112+
---
113+
103114
## Release checklist
104115

105116
When cutting a `coven-code` release:

0 commit comments

Comments
 (0)