Skip to main content

sos custom-script

Custom Script management

Description

Provides commands for developing and deploying custom scripts to signageOS devices. Custom Scripts enable advanced device functionality beyond standard applets, including system-level operations and device-specific configurations.

Usage

sos custom-script <subcommand> [options]

Subcommands

upload

Upload custom script to the signageOS platform

sos custom-script upload [options]

→ See detailed documentation

generate

Generate a local repository for developing a Custom Script

sos custom-script generate [options]

→ See detailed documentation

Examples

# Generate new custom script project
sos custom-script generate

# Upload custom script to platform
sos custom-script upload

Since

1.8.0

Global Options

All commands support the following global options:

OptionAliasDescription
--help-hDisplay help information for any command
--version-vDisplay the installed version of the CLI
--api-url-uOverride the API URL for REST requests
--profileUse 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

See Also