docs(cli): record retirement of status --json in v8 migration

Open
#464 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
cli, documentation

Research direction

Start with PR #795 and its command-surface smoke test, then check the v8 release or migration note against the acceptance criteria. Done means the obsolete status surface is absent, doctor’s human diagnostic role is documented, and the migration note states that doctor is not a JSON-compatible replacement.

Written by the indexing model from the issue text.

Description

good first issue

Context

On next, the documentation promises aidd status --json for CI, while the shipped command rejects the flag. That mismatch is real.

PR #795 deliberately replaces the old CLI surface:

  • aidd status is retired.
  • aidd doctor becomes the human diagnostic view and includes drift alongside installation health.
  • Machine-readable output remains command-specific: aidd framework rules --json and aidd telemetry report --json. There is no generic output mode.

The PR already removes the obsolete status --json promise from CLI memory. Reintroducing the old command or adding doctor --json here would work against that new surface and would create an unplanned general output contract.

Decision

Treat this as a v8 migration/documentation gate for #795, not as implementation of status --json.

This decision intentionally leaves no machine-readable full-drift replacement. A consumer that needs one must justify a separate, versioned report contract; it must not silently substitute doctor text parsing.

Acceptance criteria

  • #795 contains no aidd status command or status --json documentation promise.
  • aidd doctor documents and presents the human drift/health diagnostic role.
  • The v8 release or migration note explicitly states: aidd status and its undocumented JSON contract are removed; aidd doctor is the human replacement, not a JSON-compatible replacement.
  • The command-surface smoke test reflects the retirement.
  • #795 links this issue and it is closed only after that PR merges.

Boundary

Do not add --json to doctor, an alias for status, or a generic output abstraction. Those are separate product decisions.

Dominant language
TypeScript
Stars
481
Forks
45
Avg merge
14h 36m
Merged PRs (30d)
110

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ai-driven-dev/framework

All issues in ai-driven-dev/framework

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.