Skip to content

Update README with enhanced cmax CLI details #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JordanNanos merged 1 commit into from
Aug 30, 2026
Merged

Update README with enhanced cmax CLI details #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# ClusterMAX

This repo is for `cmax`, a CLI tool that we use to audit GPU clusters and standalone machines during research for ClusterMAX. The initial release supports our recent article on neocloud security that precedes ClusterMAX 3.0.
This repo is for `cmax`, a CLI tool that we use to audit GPU clusters and standalone machines during research for ClusterMAX.

Version 0.2.1 of the `cmax` CLI provides these functional commands:
The initial release is a small subset of our full test suite. It supports our recent article on neocloud security that precedes ClusterMAX 3.0.

This version of the `cmax` CLI provides the following commands:

| Command | Function |
|---|---|
| `cmax audit security` | This command runs a focused, read-only security audit. |
| `cmax audit` | This command runs the complete cluster audit. |
| `cmax audit review` | This command reviews a saved audit without new checks. |
| `cmax audit` | This command runs a full cluster audit covering more than just security. |
| `cmax audit review` | This command reviews a saved audit output without running new checks. |

## Install ClusterMAX

Expand Down