runner

Runner management

Description

Runner management operations for developing and deploying signageOS runners.

Runners are designed for continuous execution as background processes on devices. Once activated, they run indefinitely with active health monitoring and automatic restart capabilities for stability.

Runners must implement run, set, and get methods. Upload reads .sosconfig.json for configuration.

Usage

sos runner <subcommand> [options]

Subcommands

generate

Generates a local repository for developing a Runner

sos runner generate [options]

→ See detailed documentation

upload

Uploads current runner version

sos runner upload [options]

→ See detailed documentation

Examples

# Generate new runner project
sos runner generate --name my-runner --description "Background service" --yes

# Upload runner to platform
sos runner upload --yes

Since

2.6.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 runner generate - Generates a local repository for developing a Runner
• sos runner upload - Uploads current runner version