docs(cli): make current CommandF capabilities usable from README (signed)

Merged
TH
7d ago
+107-10

Make the actual local CommandF CLI discoverable

This is a signed + DCO replacement for historical unsigned PR #189.
It starts from the exact current protected main, carries the
previous documentation improvements without inheriting unsigned
commits, and updates them for capabilities merged since #189.

Scope

  • Only README.md changes. No CI, protected governance, Cargo,
    dependency, production Rust, or licensing changes.
  • Explain experimental source-checkout CLI setup and real available
    pkg resolve/verify, inspect, context, diff, classify, impact, check,
    review-preview, gate, terminology, oracle, source-map and
    github-annotations commands.
  • Add an actual review-preview SARIF example and distinguish its
    non-atomic partial structural/declared-graph output from the
    currently unimplemented complete consumer-contract review.
  • Note unresolved FHIR official-source byte discrepancy #214
    and intermittent DNS #221 without treating either as fixed.
  • Update stale Windows verifier-path note after PR #212 and
    leave separate macOS protected AF-02 issue #215 open.
  • Clearly avoid claiming a root license, certified clinical safety,
    publisher authenticity, general version support, signed receipts,
    Studio UI, or stable release.

Mac qualification

  • Actual cargo +1.97.1 run --locked -p commandf --
    review-preview --help succeeded and printed matching declared flags:
    before/after locks and caches, direction, fail-on, format json/sarif,
    output.
  • git diff --check PASS.
  • Candidate GitHub commit is signed/Verified and DCO compliant.
  • Required exact-head CI must all pass before normal merge.
    Founder-adopted zero-human-approval rule remains in force.
  • Do not bypass FHIR package acquisition or any security check.

Supersession

PR #189 remains as a historical source of the initial docs proposal;
its unverified/no-DCO commits will NOT be merged or rewritten.
This signed replacement is the only candidate for admission.


Summary by cubic

Replaces the obsolete CF-01-only README onboarding with an accurate map of the currently implemented Rust CLI, so the actual local CommandF capabilities are discoverable. Documentation-only change based on current protected main; supersedes the unsigned historical PR #189 without rewriting its history.

  • Documents the executable pkg resolve/verify, inspect, context, diff, classify, impact, check, review-preview, gate, terminology, oracle, source-map, and github-annotations commands with runnable local examples.
  • Distinguishes the bounded, non-atomic review-preview output from the unimplemented complete consumer-contract review command and signed receipts.
  • Records the unresolved FHIR registry byte discrepancy (#214) and intermittent DNS failures (#221) as known limits, without treating either as fixed.
  • Updates the Windows verifier-path note from PR #212 and explicitly leaves the macOS AF-02 issue (#215) open.
  • Avoids claiming a root license, clinical safety certification, publisher authenticity, general version support, or a stable release.