search
Search the public signageOS documentation and print matching passages as JSON
Description
Searches the public signageOS documentation (docs.signageos.io) by meaning, not just keywords, and prints the matching passages with their page URLs as JSON. Meant for AI agents and scripts that need an authoritative answer before acting; no login required. Uses https://docs-search.signageos.io by default. Set SOS_DOCS_URL to override the search endpoint.
Usage
sos docs search [options]
Options
| Option | Description |
|---|---|
--query | What to look up, in plain words (string) |
--limit | Number of results, 1-10 (default 5) (number) |
Examples
sos docs search --query "how do I assign an applet to a device with configuration"
sos docs search --query "BrightSign native debug" --limit 3
Since
4.5.0
Global Options
All commands support the following global options:
| Option | Alias | Description |
|---|---|---|
--help | -h | Display help information for any command |
--version | -v | Display the installed version of the CLI |
--api-url | -u | Override the API URL for REST requests |
--profile | Use a specific profile from ~/.sosrc config |
Examples
# Show version
sos --version
# Get help for any command
sos applet --help
sos applet upload --help
# Use custom API endpoint
sos --api-url https://api.example.com applet upload
# Use specific profile
sos --profile production organization list