OpenSite/Reference/Commands/Settings commands

OpenSite 0.0.1 · DevelopmentSource scope and availability

Inspect, change, reset, save, or load a user setting.

Stable identifier

cli.settings

Implementation milestone

Roadmap phase 3.

Units

The printed value is the setting value. It is not an SI quantity.

Terminal example

opensite-cli settings get locale.country

Python access

opensite.execute('settings.get', {'key': 'locale.language'})

Output

Stdout is key=locale.country, value=, and source=application when no file is loaded.

Errors

Exit 0 on success. Exit 1 when the key or file is rejected. Exit 2 when the arguments are not supported.

Limitations

Set and reset write the user scope. Pass --workspace or --document on get to name a context id. The service does not open that workspace or document.

Verification evidence

Repository evidence references (not rerun for this publication): CTest cli.preferences, including a path that contains a space.

opensite-cli settings set locale.country FR --file preferences.json writes the user value and prints source=user. settings reset locale.country --file preferences.json prints reset locale.country. The next get on that file prints source=application.

Try this workflow

Set preferences — 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

Previous: OpenSite/Reference/Commands/Command line

Next: OpenSite/Reference/Commands/Unit commands

All guides