docs: CLI conventions for the openab command surface#1452
Merged
Conversation
thepagent
approved these changes
Jul 25, 2026
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.
Docs-only. Records the CLI taxonomy rule settled in the #1449 review discussion: top-level verbs act on the bot itself (
run|setup|set|get, frozen); subsystems and add-ons live under noun namespaces (openab mcp <addon> <action>); production serving is config-driven (openab run+ config sections), with namespaceserveactions reserved for dev/standalone use (#1451).Review Contract
Goal
Add
docs/cli-conventions.mdso future CLI additions follow one documented taxonomy instead of case-by-case debate.Non-goals
set/getstay).Accepted Residual Risks
Acceptance Criteria
openabsubcommand without exception (reviewer check againstsrc/main.rsCommands enum).Follow-ups
openab mcpadd-ons ship.