True up the README against the shipped CLI#41
Merged
Merged
Conversation
Doc-vs-code verification pass over the command reference. Every command, subcommand, and flag spelling in the README was checked against the cobra registrations in cmd/; the mismatches found all undersold what the binary supports: - remediate: the supported-types sentence and the --type flag row listed storage and network only; cmd/remediate.go handles a third type, orphans (delete-snapshot / deregister-image scripts from a saved orphans report). Both now list storage, network, orphans. - lambda audit, k8s rbac, compliance, drift: the --output flag rows claimed table, json; all four commands also emit sarif (cmd/lambda.go, cmd/k8s.go, cmd/compliance.go, cmd/drift.go). The rows now match the other sarif-capable commands' tables. - iam fix: flag table was missing --profile (AWS named profile, matching the profile used for the scan) — present in cmd/iam.go. - storage audit: flag table was missing --fix / --out, which the command supports symmetrically with network audit (cmd/storage.go). - --version example: cobra's default version template prefixes the output with "cloudgov version ", so the sample output line now shows the string the binary actually prints. Co-authored-by: stxkxsbot <275011021+stxkxsbot@users.noreply.github.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.
See commit message. remediate orphans documented; sarif output rows, iam fix --profile, storage audit --fix/--out, version output prefix — all re-verified against HEAD.