docs(readme): the agent fingerprint, the v0.2.0 release, and a gap worth stating - #41
Draft
trionnemesis wants to merge 1 commit into
Draft
docs(readme): the agent fingerprint, the v0.2.0 release, and a gap worth stating#41trionnemesis wants to merge 1 commit into
trionnemesis wants to merge 1 commit into
Conversation
…rth stating Both READMEs describe `agentsec scan` as if it only ranked attack surface. It now answers what the repository *is* first, and the Traditional Chinese edition did not mention the classification at all — the two files had drifted in both directions, so this closes the gap each way: en gains the static-posture and provenance rows zh-TW already had, zh-TW gains the fingerprint section and sample output en already had. Three things a first-time reader can now act on: - **Install from the release.** v0.2.0 ships a wheel and an sdist, so "install from source" is no longer the only option, and anything whose pass/fail matters should pin a release rather than `main` — a change here would otherwise move another repository's merge decisions. - **`configuration_only` is spelled out.** A repository holding only a `CLAUDE.md` and a `.mcp.json` is not a runtime agent, and `not_detected` is an absence of evidence rather than a pass. Saying this in the README is what keeps a reader from reading the screen the way the code refuses to. - **The catalogue does not travel with the CLI.** Outside a checkout of AgentSec, `<workspace>/scenarios` is empty and every risk resolves to `not_verifiable` — correct, and easy to misread now that the line above it can say `confirmed langgraph`. Stated in Status rather than left to be discovered. Docs only; 397 passed, 2 skipped.
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.
What changed
Both READMEs described
agentsec scanas if it only ranked attack surface. It answers what the repository is first now, and the Traditional Chinese edition did not mention that classification at all.The two files had drifted in both directions, so this closes the gap each way:
README.mdREADME.zh-TW.mdType
Purple coverage
Three things a first-time reader can now act on
Install from the release. v0.2.0 ships a wheel and an sdist, so "install from source" is no longer the only option. Both READMEs now lead with the pinned wheel and say why: anything whose pass/fail you care about should pin a release rather than
main, the CI gate especially, since a change here would otherwise move another repository's merge decisions. The URL is thebrowser_download_urlfrom the release itself.configuration_onlyis spelled out in prose. A repository holding only aCLAUDE.mdand a.mcp.jsonis not a runtime agent, andnot_detectedis an absence of evidence rather than a pass. The code refuses to conflate those; the README should not let a reader do it on the code's behalf.The catalogue does not travel with the CLI. Outside a checkout of AgentSec,
<workspace>/scenariosis empty and every risk resolves tonot_verifiable. That was already true and already recorded indocs/feature-matrix.md, but it is newly easy to misread now that the line above it can sayconfirmed langgraph— so it is stated in Status, where someone hits it before their first run rather than after.Checks
pytest— 397 passed, 2 skipped (docs-only change; no test reads the root READMEs)Notes for the reviewer
Statuscaveat is the one paragraph here that is not purely descriptive — it documents a limitation rather than a feature. It belongs in the README rather than only in the feature matrix because it changes what the first run looks like, but it is fair to argue it reads as an apology in a section people skim.## Whyor scope sections; scenario counts, OWASP coverage and resource counts were already correct as of docs(readme): correct scope facts stale since the agent-configuration family #34.Generated by Claude Code