docs(cli): add CLI reference + README CLI Quick Start#511
Merged
Conversation
Add docs/reference/cli/README.md as the canonical man-page-style CLI reference (17 subcommands, global flags, shared flag groups, volume/port grammar, output formats, exit codes). Fold the installer trust-model walkthrough (sigstore, SHA256SUMS, gh attestation verify) into the new reference's Installation & Verification section, retiring the orphan docs/install/verification.md. Restructure README quick starts: add a CLI Quick Start matching the SDK pattern, slim the REST API Quick Start install block to a pointer into the CLI Quick Start, and replace "API Reference - Coming soon" in the Documentation section with a real link. Update docs/reference/README.md index and CLAUDE.md to surface the new CLI surface and the reference umbrella.
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.
Summary
docs/reference/cli/README.md(640 lines): man-page-style reference covering all 17 subcommands, global flags, shared flag groups (ProcessFlags/ResourceFlags/PublishFlags/VolumeFlags/ManagementFlags), volume & port grammars, output formats, configuration file format, and exit codes. Source-of-truthfile:linerefs cited throughout.README.md: added a new CLI Quick Start (matching the SDK pattern), slimmed the REST API Quick Start's install block from a ~65-line trust-model walkthrough down to a 3-line pointer, replaced "API Reference - Coming soon" with a real link to./docs/reference/.docs/install/verification.mdinto the new CLI reference's Installation & Verification section and removed the one-filedocs/install/orphan directory.docs/reference/README.mdto list the CLI alongside SDKs, andCLAUDE.md's Project Overview to point atsrc/cli/README.mdanddocs/reference/README.md.No code changes — docs only.
Test plan
docs/reference/cli/README.mdon GitHub and verify the TOC anchors resolve and every command section is reachable.BOXLITE_VERSION,BOXLITE_INSTALL_DIR,BOXLITE_EXPECTED_SHA256,sha256sum -c,gh attestation verify install.sh,gh attestation verify ...boxlite-cli...) all appear in the new reference's Installation & Verification section.README.md(CLI Quick Start, REST API Quick Start) andsrc/cli/README.md(Installation section) resolve.