Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| CLI Reference |
run command absent from CLI reference table |
README.md |
| Architecture tree |
src/run.rs not listed in the directory tree |
AGENTS.md |
Details
1. run command missing from README.md CLI Reference
src/main.rs defines eight subcommands via the Commands enum:
init, compile, check, mcp, mcp-http, execute, configure, run
The README.md CLI Reference block (around line 439) lists only seven β run is absent:
Commands:
init Initialize a repository for AI-first agentic pipeline authoring
compile Compile markdown to pipeline definition
check Verify a compiled pipeline matches its source
mcp Run as an MCP server (safe outputs)
mcp-http Run as an HTTP MCP server (for MCPG integration)
execute Execute safe outputs (Stage 3)
configure Detect agentic pipelines and update GITHUB_TOKEN on ADO definitions
# β run is missing
```
`AGENTS.md` *does* document the `run` command (lines 1007β1013) with full flag details β so the fix is to add a matching entry to `README.md`.
The `run` command is the primary local development tool (starts SafeOutputs + MCPG, runs copilot, executes safe outputs end-to-end), so its omission from the user-facing README is a meaningful gap.
#### 2. `src/run.rs` missing from `AGENTS.md` architecture tree
The architecture tree in `AGENTS.md` (lines 20β84) lists all source files but omits `src/run.rs`, which implements the `run` subcommand. All other top-level `src/*.rs` files are listed.
Actual top-level source files include:
```
src/agent_stats.rs β
listed
src/allowed_hosts.rs β
listed
src/configure.rs β
listed
src/detect.rs β
listed
src/ecosystem_domains.rs β
listed
src/execute.rs β
listed
src/fuzzy_schedule.rs β
listed
src/init.rs β
listed
src/logging.rs β
listed
src/main.rs β
listed
src/mcp.rs β
listed
src/ndjson.rs β
listed
src/run.rs β MISSING
src/sanitize.rs β
listed
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β 2M Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
runcommand absent from CLI reference tableREADME.mdsrc/run.rsnot listed in the directory treeAGENTS.mdDetails
1.
runcommand missing fromREADME.mdCLI Referencesrc/main.rsdefines eight subcommands via theCommandsenum:init,compile,check,mcp,mcp-http,execute,configure,runThe
README.mdCLI Reference block (around line 439) lists only seven βrunis absent:Suggested Fixes
runentry to theREADME.mdCLI Reference block with its flags (--pat,--org,--project,--dry-run,--skip-mcpg,--output-dir)src/run.rsto the architecture tree inAGENTS.mdwith a brief description (e.g.,# Local development run orchestrator)This issue was created by the automated documentation freshness check.