docs

Documentation lookup

Description

Looks things up in the public signageOS documentation.

Usage

sos docs <subcommand> [options]

Subcommands

search

Search the public signageOS documentation and print matching passages as JSON

sos docs search [options]

→ See detailed documentation

Examples

sos docs search --query "applet timing configuration"

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

Related Commands

• sos docs search - Search the public signageOS documentation and print matching passages as JSON