BathAfrica: Publish professional OpenSite help structure and learning paths

2026-10-29T21:01:38Z

Publish professional OpenSite help structure and learning paths

New page

__NOTOC__
{{OpenSite scope}}
{{OpenSite lesson
|id=opensite.help.discover-commands
|summary=List registered command names and execute one documented read-only setting query.
|prerequisites=An embedded OpenSite host. A command listing is metadata, not proof that every command is available or authorized.
|steps==== List the registry ===
Use <code>opensite.commands()</code> in Python, or <code>opensite-cli commands</code> in a terminal.

=== Inspect an entry ===
Use <code>opensite-cli commands show opensite.document.set_quantity</code> to inspect its descriptor. Check arguments, version and capability before executing it.

=== Run a small read operation ===
Read <code>locale.language</code> using <code>settings.get</code>. Preserve the returned field rather than guessing text formatting.

=== Handle availability ===
Unknown, unavailable and unauthorized are different failures. Listing a plugin descriptor does not necessarily load the plugin.

|result=Document/material command names are printed and the language setting is returned.
|limitations=The development CLI’s allow-all policy is not a production account entitlement. Ordinary local workspace operations and protected engineering capabilities have different policy rules.
}}

== Complete example ==
{{Code|lang=python|code=<nowiki>import opensite

commands = opensite.commands()
for name in sorted(commands):
if "material" in name or "document" in name:
print(name)
language = opensite.execute("settings.get", {"key": "locale.language"})
print("Language setting:", language["value"])</nowiki>}}

<div class="os-page-nav">{{Docnav|OpenSite/Guides/Run your first script|OpenSite/Guides/Debug a Python script|OpenSite/Guides|All guides}}</div>
[[Category:OpenSite documentation]]

OpenSite/Guides/Discover commands - Revision history

BathAfrica: Publish professional OpenSite help structure and learning paths