Document the task-oriented HypAware CLI - #862
Merged
Merged
Conversation
philcunliffe
force-pushed
the
codex/cli-command-documentation
branch
from
August 19, 2026 13:21
08afbb9 to
44e9e17
Compare
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.
Summary
Documentation coverage
The guide covers first installation, ordinary reconfiguration, compatible upgrades, breaking-version upgrades, and reinstallation or recovery. The reference documents every shipped visible group and leaf with syntax, availability, effects, important options, stable output or exit behavior, and an example.
Hidden credential and hook machine contracts remain excluded. Hidden Gas City routes remain unavailable. The future
setup update,setup repair, andsetup rollbackflows are clearly labeled as planned rather than shipped.Verification
node --test test/core/cli-consistency-gate.test.js test/core/group-and-verb-help.test.jsnpm run typechecknpm test(local: 4,505 passed, 2 skipped, 0 failed)git diff --checkauditsGitHub test jobs currently inherit the existing #857 failure in
test/core/command-dispatch.test.js: the clean CI configuration omits inactivegraphfrom top-level help, while that assertion expects it. The same Node 22 and Node 24 jobs fail on #857; type checking passes. This documentation-only layer does not change code or tests.Stack dependency
This documentation PR depends directly on #857 and intentionally uses
codex/cli-reorgas its base. Reviewers therefore see only the documentation layer. Do not merge this PR before #857.