sos
SignageOS CLI - The central command-line tool for deploying, managing, and debugging signageOS projects and devices
Overview
The signageOS CLI is a command-line tool for managing applets, devices, organizations, and other signageOS resources. It provides a comprehensive set of commands for the complete development lifecycle from applet creation to deployment.
Key Features
- Applet Development: Create, build, test, and deploy applets
- Development Tools: Connect to devices for testing, upload custom scripts and debug
- Device Management: Control device power states and applet timings
- Organization Management: Handle multi-tenant environments
- Authentication: Secure login and profile management
Installation
npm install -g @signageos/cli
Getting Started
- Login to your account:
sos login
- Generate a new applet:
sos applet generate --name my-applet
- Start development:
cd my-applet && sos applet start
Usage
sos [options] <command>
Debugging
To enable debugging for specific modules, use the DEBUG
environment variable:
# Debug applet upload module
DEBUG=@signageos/cli:Applet:Upload:appletUploadFacade sos applet upload
# Debug all signageOS modules
DEBUG=@signageos/* sos applet upload
# Set debug environment variable
export DEBUG=@signageos/*
Description
The root command for the signageOS CLI tool that provides comprehensive management capabilities for applets, devices, organizations, and other signageOS resources. This command serves as the entry point for all CLI operations and coordinates access to all available command groups.
Options
Option | Alias | Description |
---|---|---|
--command | -c | (default) Command name (string) |
--help | -h | Display this usage guide. (boolean) |
--api-url | -u | API URL to be used for REST requests (string) |
--version | -v | Display installed version of the CLI. (boolean) |
--profile | signageOS Profile to be used for authentication and other values from ~/.sosrc config file. (string) |
Commands
Development
sos applet
Applet development and management operations
Available commands: sos applet generate
, sos applet upload
, sos applet start
, sos applet test
, sos applet build
sos custom-script
Custom Script management
Available commands: sos custom-script upload
, sos custom-script generate
Authentication
sos login
Authenticate user with signageOS
Management
sos organization
Organization management operations
Available commands: sos organization list
, sos organization get
, sos organization set-default
sos timing
Timing management
Available commands: sos timing list
sos device
Device management
Available commands: sos device set-content
, sos device power-action
, sos device connect
Tools
sos autocomplete
CLI auto-completion management
Available commands: sos autocomplete install
, sos autocomplete uninstall
Examples
# Show help and available commands
sos --help
# Show version information
sos --version
# Use custom API endpoint
sos --api-url https://api.custom.signageos.io applet list
Since
0.1.0
Related Commands
sos applet
- Applet development and management operationssos login
- Authenticate user with signageOSsos organization
- Organization management operationssos timing
- Timing managementsos device
- Device managementsos custom-script
- Custom Script managementsos autocomplete
- CLI auto-completion management