docs: restructure README and correct unshipped commands - #27
Merged
Merged
Conversation
Lead with what AXguard does and how to run it instead of author credibility. Merge the two overlapping command tables, cut three redundant flow diagrams, and add the sections the README was missing: worked example output, supported languages, privacy, troubleshooting, and uninstall. Remove `axguard preship` and `axguard diff`. Neither is registered in cli/main.py on main; both live on unmerged feature branches, so the README's second section sent readers to a command that does not run. Pre-ship review is documented as the axguard-preship and axguard-cso skills over `axguard audit`, which is what ships today. This also drops the links to docs/preship.md and docs/security-diff.md, the only two broken relative links in the file.
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
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.
Restructures the README around what a new reader needs first: what AXguard is, how to install it, and what its output actually looks like. 819 lines → 595, with more information in it, not less.
Why
The README grew by accretion — each feature added a section. The result buried the basics:
The important fix: two commands that do not exist
axguard preshipandaxguard diffare documented onmainbut are not registered incli/main.py. There is no parser, no dispatch branch, and noengines/security_diff/. Both live onfeat/axguard-preshipandfeat/axguard-security-diff, which have not merged.This mattered because
axguard preship .was the second section of the README and its flagship example. Anyone following along hitcommand not found.The real top-level CLI is 22 commands:
about adversary api audit contribute data engage evidence flow github help investigate memory mcp paths(aliasattack-paths)predict privacy scan surface twin verify version.Both are removed here. Pre-ship review is now documented as what actually ships — the
axguard-preshipandaxguard-csoskills overaxguard audit. They can go back in the README when their branches land.This also removes the links to
docs/preship.mdanddocs/security-diff.md, which were referenced three times and do not exist. They were the only two broken relative links in the file.Smaller accuracy fixes
--format {text,json,md,html}is documented asscan-only.audithas no--formatand always writes all three.--fail-onis documented asscan/audit-only.surface,flow,verify,adversary,evidenceandpathsalways return0and cannot gate CI — the old CI section implied otherwise.axguard githubissetup|validate|test|status; running the listener is a self-hosting step.New sections
axguard scan fixtures/vuln_appandaxguard audit fixtures/vuln_app, including the severity table from the generated report. Nothing hand-written; it is what the commands print. It also showsVERIFIED=0 UNVERIFIED=12rather than hiding it.uninstall.shexisted and waschmod +x'd in Quick Start but never explained.mcp-threat-model.md,github/security.mdandgithub/troubleshooting.md.The author bio, contributions image and AwareXone section move to a Credits section at the bottom. All badges, images and contact details are kept.
Verification
](path)in the file.assets/images resolve./axguard-*command in the README has a file incommands/.axguard <cmd>in the README is checked against the parser; no unknown commands.python scripts/validate_skills.py→skills scanned: 38 OK.axguard version,axguard helpandaxguard scan fixtures/vuln_appall run clean.Only
README.mdchanges.Follow-ups (not in this PR)
pyproject.toml0.2.0,.claude-plugin/plugin.json0.1.0,skills/index.yaml0.3.0-dev, and the ASCII banner printsv0.1.uninstall.shis incomplete — its hardcoded arrays omit theaxguard-securityskill and theaxguard-contribute.md/axguard-privacy.mdcommands, so those are left behind.CLAUDE.mdlists/axguard-diff, which has no command file — same class of error as the one fixed here.docs/preship.mdanddocs/security-diff.mdshould be written when those features merge.