OpenSite/Reference/Commands/Command line: Difference between revisions
BathAfrica (talk | contribs) Use BathAfrica sidebar contents without duplicate inline contents box |
BathAfrica (talk | contribs) 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 | ||
|id=cli.version | |id=cli.version | ||
|summary=Print the OpenSite platform version. | |summary=Print the OpenSite platform version. | ||
| Line 16: | Line 16: | ||
<code>--help</code> and an invocation with no arguments print help on stdout and exit 0. An unknown option exits 2 and writes the reason to stderr. Help states that this build does not analyze, mesh, check a design code, or load plugins. Help also names <code>settings</code>, <code>units</code>, and <code>language</code>. Those commands are [[OpenSite/Reference/Commands/Settings commands|Settings commands]], [[OpenSite/Reference/Commands/Unit commands|Unit commands]], and [[OpenSite/Reference/Commands/Language commands|Language commands]]. | <code>--help</code> and an invocation with no arguments print help on stdout and exit 0. An unknown option exits 2 and writes the reason to stderr. Help states that this build does not analyze, mesh, check a design code, or load plugins. Help also names <code>settings</code>, <code>units</code>, and <code>language</code>. Those commands are [[OpenSite/Reference/Commands/Settings commands|Settings commands]], [[OpenSite/Reference/Commands/Unit commands|Unit commands]], and [[OpenSite/Reference/Commands/Language commands|Language commands]]. | ||
== Try this workflow == | |||
[[OpenSite/Guides/Discover commands|Discover commands]] — a worked lesson with expected results. | |||
== Documentation basis == | == Documentation basis == | ||
| Line 27: | Line 30: | ||
[[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/Language commands|OpenSite/Reference/Commands/Settings commands|OpenSite/Guides|All guides}}</div> | |||
Latest revision as of 14:14, 29 October 2026
Print the OpenSite platform version.
- Stable identifier
cli.version
Implementation milestone
CLI identity and command entry point in the reviewed development snapshot.
Units
The version components are dimensionless integers.
Terminal example
Python access
There is no Python function for --version. The running module is the phase 6 host, not this CLI.
Output
Stdout is OpenSite 0.0.1 for this build, with no stderr.
Errors
Exit 0. opensite-cli --version extra exits 2.
Limitations
This command reports build identity. It does not perform an analysis, mesh generation or design-code check. The desktop and Python hosts are separate executables.
Verification evidence
Repository evidence references (not rerun for this publication): CTest cli.outcomes. See docs/verification/Phase-0-Acceptance.md.
--help and an invocation with no arguments print help on stdout and exit 0. An unknown option exits 2 and writes the reason to stderr. Help states that this build does not analyze, mesh, check a design code, or load plugins. Help also names settings, units, and language. Those commands are Settings commands, Unit commands, and Language commands.
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.cppsrc/cli/document_commands.cppsrc/cli/preference_commands.cppsrc/application/builtins.cpp
