Update README with enhanced cmax CLI details - #11
Merged
Conversation
Clarified the description of the `cmax` CLI tool and updated command functionalities.
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.
Clarified the description of the
cmaxCLI tool and updated command functionalities.Note
Low Risk
Documentation-only README edits with no code or behavior changes.
Overview
README intro is reorganized: the opening line no longer ties the tool description to a specific release, and a new paragraph states the public CLI is a small subset of the full test suite and supports the neocloud security article ahead of ClusterMAX 3.0.
The commands section heading drops the 0.2.1 version label in favor of “This version of the
cmaxCLI,” and the table copy is tightened—cmax auditis described as a full audit beyond security only, andcmax audit reviewas reviewing saved audit output without re-running checks.Reviewed by Cursor Bugbot for commit edcc75e. Bugbot is set up for automated code reviews on this repo. Configure here.