CLI and scripting
Use the command-line surface to start the local GUI, automate capture and diagnose engine behavior.
The CLI is an interface, not an API
OpenSS CLI is a command-line interface for people and shell scripts. It is useful developer documentation because it exposes stable command syntax, flags, output and exit behavior, but it is distinct from the HTTP API contract.
Commands that pair with the API
| Command | Use |
|---|---|
| openss gui | Start the local browser GUI and local API on an available loopback port |
| openss gui --no-open | Start without opening a browser; print the launch URL |
| openss capture | Capture a supported app and optionally analyze it from Terminal |
| openss ask | Send a direct question through the configured provider |
| openss doctor | Check Python, architecture, permissions, providers, storage and utilities |
| openss logs | Print the local rotating log path for diagnosis |
Script the safe boundary
Shell
set -euo pipefail\n\nopenss gui --no-open > /tmp/openss-gui.log 2>&1 &\nGUI_PID=$!\n\n# Read the printed local URL and launch token through your own\n# process boundary. Do not hard-code either value.Continue with the product command reference
The product docs contain the complete source-derived command reference, installation path, provider setup, capture options, history backends and troubleshooting guidance.
Contract source:
OpenSS/src/openss/gui/server.py and schemas.py.