OpenSite/Reference/Commands/Command discovery: Difference between revisions

From BathAfrica Documentation
Jump to navigation Jump to search
Use BathAfrica sidebar contents without duplicate inline contents box
Link adjacent OpenSite reference pages in reading order
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{OpenSite scope}}
{{BathAfrica Command
{{BathAfrica Command
|review=Development documentation for OpenSite 0.0.1, source snapshot 77c3fee (Phase 13C). Reviewed against implementation on 29 October 2026. Tests and the Windows desktop were not rerun for this publication; this is not a released-product support claim.
|id=cli.commands
|id=cli.commands
|summary=List registered command ids, or show one descriptor.
|summary=List registered command ids, or show one descriptor.
Line 15: Line 15:
}}
}}


== Try this workflow ==
[[OpenSite/Guides/Discover commands|Discover commands]] — a worked lesson with expected results.


== Documentation basis ==
== Documentation basis ==
Line 26: Line 29:
[[OpenSite|OpenSite overview]] · [[OpenSite/Reference|Reference]] · [[OpenSite/Guides|Guides]]
[[OpenSite|OpenSite overview]] · [[OpenSite/Reference|Reference]] · [[OpenSite/Guides|Guides]]
[[Category:OpenSite documentation]]
[[Category:OpenSite documentation]]
<div class="os-page-nav">{{Docnav|OpenSite/Reference/Commands|OpenSite/Reference/Commands/Document demo|OpenSite/Guides|All guides}}</div>

Latest revision as of 14:14, 29 October 2026

OpenSite 0.0.1 · DevelopmentSource scope and availability


List registered command ids, or show one descriptor.

Stable identifier
cli.commands

Implementation milestone

Roadmap phase 4.

Units

None. The registry does not store a quantity.

Terminal example

opensite-cli commands opensite-cli commands show opensite.document.set_quantity

Python access

opensite.commands() lists the same registry. There is no separate show function.

Output

The list prints provider.name version=N for every registered descriptor. show prints the id, version, title key, mutation policy, capability, documentation reference, and whether an executor is registered.

Errors

Exit 2 when the arguments are not supported. Exit 1 when show names a command that is not registered.

Limitations

This lists in-process registrations. It does not load a plugin. A metadata-only command would print executor=no. The development CLI installs an allow-all policy before it runs a mutating command. That policy is not an account or license check.

Verification evidence

Repository evidence references (not rerun for this publication): CTest cli.commands and application.commands. ADR-0023.


Try this workflow

Discover commands — a worked lesson with expected results.

Documentation basis

Source-reviewed against development commit 77c3fee13944bcc4b5d487c77eb1f82fbe4c6ea7, branch feature/phase-13c-properties-python-expressions. This review inspected the implementation and repository evidence; it did not run the Windows application or repeat CTest.

  • src/cli/main.cpp
  • src/cli/document_commands.cpp
  • src/cli/preference_commands.cpp
  • src/application/builtins.cpp

OpenSite overview · Reference · Guides