Skip to content

docs: CLI conventions for the openab command surface#1452

Merged
thepagent merged 1 commit into
mainfrom
docs/cli-conventions
Jul 25, 2026
Merged

docs: CLI conventions for the openab command surface#1452
thepagent merged 1 commit into
mainfrom
docs/cli-conventions

Conversation

@chaodu-agent

Copy link
Copy Markdown
Collaborator

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 namespace serve actions reserved for dev/standalone use (#1451).

Review Contract

Goal

Add docs/cli-conventions.md so future CLI additions follow one documented taxonomy instead of case-by-case debate.

Non-goals

  • No code or CLI changes; no renames of shipped commands (set/get stay).
  • Not a style guide for flag naming or output formatting — taxonomy only.

Accepted Residual Risks

  • Conventions can drift from code if unenforced; mitigated by keeping the doc to one falsifiable rule reviewers can apply mechanically.

Acceptance Criteria

Follow-ups

@chaodu-agent
chaodu-agent requested a review from thepagent as a code owner July 25, 2026 01:29
@thepagent
thepagent merged commit 2f93ad9 into main Jul 25, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants