docs: describe the tool by what it does — check an advisory bundle - #18
Merged
Merged
Conversation
The description still read "Fleet-wide firewall impact analysis, straight from
Cisco", written before the bundle check existed. Both ledes described only the
device-by-device sweep, so the workflow the tool is actually for — hand it a
Cisco Event Response link, learn which of your devices and releases that
publication impacts — was invisible until deep into "Run it".
New description, applied to all nine places one lives:
Check a Cisco advisory bundle against your firewall inventory
Four shared the old literal (README, docs/index.html, pyproject, the banner
slogan); the rest are the meta description, both ledes, --help, and the package
docstring. "Run it" is restructured so the bundle prompt is the flow, with
--erp for scheduling right after it.
Two gaps this turned up, both worth more than the wording:
- --erp was missing from the README's automation flag table. That absence is
why it looked like the flag did not exist at all. Added, with a runnable
scheduled-review example, and the exit-codes line now covers the bundle
failures (2 for a value that is not a bundle address, 1 for unreachable or a
page yielding no advisories, no report written either way).
- sec.cloudapps.cisco.com was absent from the network prerequisites in both
files and from the "Could not reach Cisco" troubleshooting entry. A user
behind a corporate proxy would have been blocked on the bundle fetch with
nothing in the docs explaining why.
The whole-inventory report keeps a short note at the end of "Run it" rather
than equal billing. It still works, so hiding it would misdescribe the tool in
the other direction, but it is no longer what the tool announces itself as.
"Fleet" survives in three places deliberately: the two disclaimers, where the
strong word is doing real work, and the uninstall example, which is about
machines rather than firewalls.
No VERSION bump: docs and packaging metadata only, matching f78ca51, e156578
and 73de536 — e156578 changed a pyproject field, the same category as this.
Co-Authored-By: Claude Opus 5 <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
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.
The description still read "Fleet-wide firewall impact analysis, straight from Cisco" — written before the bundle check existed. Both ledes described only the device-by-device sweep, so the workflow the tool is actually for was invisible until deep into "Run it".
New description
In the banner:
Applied to all nine places a description lives. Four shared the old literal (
README.md,docs/index.html,pyproject.toml, the banner slogan); the rest are the<meta>description, both ledes,--help, and the package docstring — that last one only turned up by grepping for the stale string.Run itis restructured so the bundle prompt is the flow, with--erp ERP-75736immediately after it for scheduling.Two gaps this turned up, both worth more than the wording
--erpwas missing from the README's automation flag table. That absence is why it looked like the flag didn't exist at all — the table is where you'd look. Added, with a runnable scheduled-review example. The exit-codes line below it now covers the bundle failures too:2for a value that isn't a bundle address,1for Cisco unreachable or a page yielding no advisories, and no report written either way.sec.cloudapps.cisco.comwas absent from the network prerequisites — in both files, and from theCould not reach Ciscotroubleshooting entry. A user behind a corporate proxy would have been blocked on the bundle fetch with nothing in the docs explaining why. Now listed alongsideapix.cisco.comandid.cisco.com, with a note on which does what.What is deliberately kept
The whole-inventory report (press Enter at the prompt) keeps a short note at the end of "Run it" rather than equal billing. It still works, so removing it from the docs would misdescribe the tool in the other direction — but it is no longer what the tool announces itself as.
"Fleet" survives in three places on purpose: the two disclaimers (
not a whole-inventory assessment), where the strong word is doing real work, and--uninstall --yes # for scripts / fleet cleanup, which is about machines rather than firewalls.Also considered and not done: removing
--erpto make the tool single-purpose. Principle III requires every capability be reachable "without human input", and the ERP link is the tool's only required input — dropping the flag would leave its sole function invocable only by a human at a prompt, breaking scheduled reviews (User Story 2) and the container harness's automated checks.Scope
Documentation and packaging metadata only. No behaviour change; 402 tests pass unchanged.
No
VERSIONbump — matchingf78ca51,e156578and73de536, all docs-only and none bumped.e156578changed apyproject.tomlfield, the same category asdescription.🤖 Generated with Claude Code