docs: fix CLI reference drift in README and AGENTS.md#128
Merged
Conversation
Audited the docs against the code and corrected verified drift: - README: replace non-existent `--model` flag with the real `--worker-model` / `--architect-model` options in the analyze example and the Common flags table. - README: `stride-gpt config` isn't a command — point users at the REPL `/config` instead. - README: drop the bogus `[ui]` pip extra claim; the web UI installs via apps/web/requirements.txt. - README: refresh stale model versions (GPT-5.4/5.5, Claude 4.6/4.8) in the Features list and example model ids. - README: rebuild the Table of Contents — fix the dead "Star the Repo" and "Roadmap" anchors, add the missing "Repository layout" and "Security Best Practices" entries. - AGENTS.md: add the mitre_enterprise and mitre_atlas reference cards (shipped in 0.17) to the layout tree and card catalogue. - .gitignore: keep the local doc-review.html report out of VC. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Doc-review audit of the docs against the actual code surfaced a cluster of drift in the README's CLI reference plus a stale card list in AGENTS.md. Every fix here was verified against the code/config — no speculative changes.
High — documented invocations that would error
--modelflag doesn't exist. The analyze example and Common-flags table used--model; the CLI actually exposes two tiers,--worker-modeland--architect-model. Updated the example and split the table row in two.stride-gpt configisn't a command. Onlyanalyze/quick/reportsare real subcommands; config lives at/configinside the REPL. Reworded the install step.Medium
[ui]pip extra in the repo-layout note — pyproject.toml defines no extras; the web UI installs viaapps/web/requirements.txt.models.py).#star-the-repo(section is now "Support the Project") and#roadmap(no such section).mitre_enterpriseandmitre_atlasreference cards shipped in 0.17.Low
Changelog history (the v0.15 entries mentioning GPT-5.2 / Claude 4.5) was intentionally left frozen.
Test plan
stride_gpt/cli.py,stride_gpt/models.py,pyproject.toml, and thecore/prompts/threat_model/card directory.🤖 Generated with Claude Code