@signageos/cli 2.4.1 → 2.5.0

package/docs/device/index.md

@@ -0,0 +1,105 @@
+---
+id: device-index
+title: device
+sidebar_position: 30
+---
+# device
+
+Device management
+
+
+## Description
+
+Provides commands for managing signageOS devices, including connecting to devices
+for development, controlling device power states, and managing applet deployment.
+
+## Usage
+
+```bash
+sos device <subcommand> [options]
+```
+
+## Subcommands
+
+### set-content
+
+Deploy applet to device
+
+```bash
+sos device set-content [options]
+```
+
+[→ See detailed documentation](set-content/)
+
+### power-action
+
+Perform power action on device
+
+```bash
+sos device power-action <actionType> [options]
+```
+
+[→ See detailed documentation](power-action/)
+
+### connect
+
+Connect device to local development server
+
+```bash
+sos device connect [options]
+```
+
+[→ See detailed documentation](connect/)
+
+
+## Examples
+
+```bash
+# Connect to device for development
+sos device connect --device-uid device123
+
+# Control device power actions
+sos device power-action reload --device-uid device123
+
+# Deploy applet to device
+sos device set-content --device-uid device123
+```
+
+## Since
+
+0.9.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
+
+```bash
+# 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 device set-content`](set-content/) - Deploy applet to device
+- [`sos device power-action`](power-action/) - Perform power action on device
+- [`sos device connect`](connect/) - Connect device to local development server

package/docs/device/power-action/index.md

@@ -0,0 +1,130 @@
+---
+id: device-power-action-index
+title: power-action
+sidebar_position: 32
+---
+# power-action
+
+Perform power action on device
+
+
+## Description
+
+Executes various power and control actions on remote signageOS devices, including
+applet reloads, display power management, system reboots, and applet state changes.
+This command provides remote device management capabilities for troubleshooting
+and maintenance operations.
+
+## Usage
+
+```bash
+sos device power-action <actionType> [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+| `--device-uid`              | Device UID (string)                                              |
+| `--type`                    | Type of device power action (string)                             |
+
+## Examples
+
+```bash
+# Reload applet on device
+sos device power-action reload --device-uid device123
+
+# Turn display on
+sos device power-action displayOn --device-uid device123
+
+# Turn display off
+sos device power-action displayOff --device-uid device123
+
+# Restart application
+sos device power-action restart --device-uid device123
+
+# Disable applet
+sos device power-action disable --device-uid device123
+
+# Enable applet
+sos device power-action enable --device-uid device123
+
+# Reboot device
+sos device power-action reboot --device-uid device123
+
+# Refresh content
+sos device power-action refresh --device-uid device123
+```
+
+# Reboot system
+sos device power-action reboot --device-uid device123
+
+# Refresh applet
+sos device power-action refresh --device-uid device123
+```
+
+## Advanced Usage
+
+### Power Action Types
+
+| Action      | Description                 |
+|-------------|----------------------------|
+| reload      | Applet Reload              |
+| displayOn   | Display power On           |
+| displayOff  | Display power Off          |
+| restart     | Application restart        |
+| disable     | Applet disable             |
+| enable      | Applet enable              |
+| reboot      | System reboot              |
+| refresh     | Applet Refresh             |
+
+### Usage Scenarios
+
+```bash
+# Reload applet content
+sos device power-action --device-uid device123 --type reload
+
+# Turn display off for maintenance
+sos device power-action --device-uid device123 --type displayOff
+
+# Restart the device application
+sos device power-action --device-uid device123 --type restart
+
+# Reboot the entire system
+sos device power-action --device-uid device123 --type reboot
+```
+
+
+## Since
+
+0.9.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
+
+```bash
+# 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
+```

package/docs/device/set-content/index.md

@@ -0,0 +1,72 @@
+---
+id: device-set-content-index
+title: set-content
+sidebar_position: 33
+---
+# set-content
+
+Deploy applet to device
+
+
+## Description
+
+Deploys an applet to a specific device by creating a timing configuration
+that activates the specified applet version on the target device. This command
+establishes the applet-to-device relationship for production deployment.
+
+## Usage
+
+```bash
+sos device set-content [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+| `--applet-uid`              | Applet UID (string)                                              |
+| `--device-uid`              | Device UID (string)                                              |
+
+## Examples
+
+```bash
+# Deploy applet to device
+sos device set-content --device-uid device123 --applet-uid my-applet
+
+# Deploy with organization override
+sos device set-content --device-uid device123 --applet-uid my-applet --organization-uid org456
+```
+
+## Since
+
+0.9.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
+
+```bash
+# 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
+```

package/docs/index.md

@@ -0,0 +1,168 @@
+---
+id: sos
+title: Introduction
+sidebar_position: 0
+---
+# 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
+
+```bash
+npm install -g @signageos/cli
+```
+
+### Getting Started
+
+1. **Login to your account**: `sos login`
+2. **Generate a new applet**: `sos applet generate --name my-applet`
+3. **Start development**: `cd my-applet && sos applet start`
+
+## Usage
+
+```bash
+sos [options] <command>
+```
+
+## Debugging
+
+To enable debugging for specific modules, use the `DEBUG` environment variable:
+
+```bash
+# 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`
+
+[→ See detailed documentation](applet/)
+
+#### `sos custom-script`
+
+Custom Script management
+
+**Available commands**: `sos custom-script upload`, `sos custom-script generate`
+
+[→ See detailed documentation](custom-script/)
+
+### Authentication
+
+#### `sos login`
+
+Authenticate user with signageOS
+
+[→ See detailed documentation](login/)
+
+### Management
+
+#### `sos organization`
+
+Organization management operations
+
+**Available commands**: `sos organization list`, `sos organization get`, `sos organization set-default`
+
+[→ See detailed documentation](organization/)
+
+#### `sos timing`
+
+Timing management
+
+**Available commands**: `sos timing list`
+
+[→ See detailed documentation](timing/)
+
+#### `sos device`
+
+Device management
+
+**Available commands**: `sos device set-content`, `sos device power-action`, `sos device connect`
+
+[→ See detailed documentation](device/)
+
+### Tools
+
+#### `sos autocomplete`
+
+CLI auto-completion management
+
+**Available commands**: `sos autocomplete install`, `sos autocomplete uninstall`
+
+[→ See detailed documentation](autocomplete/)
+
+
+## Examples
+
+```bash
+# 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/) - Applet development and management operations
+- [`sos login`](login/) - Authenticate user with signageOS
+- [`sos organization`](organization/) - Organization management operations
+- [`sos timing`](timing/) - Timing management
+- [`sos device`](device/) - Device management
+- [`sos custom-script`](custom-script/) - Custom Script management
+- [`sos autocomplete`](autocomplete/) - CLI auto-completion management
+
+## See Also
+
+- [CLI Setup](https://developers.signageos.io/docs/cli-setup/)

package/docs/login/index.md

@@ -0,0 +1,122 @@
+---
+id: login-index
+title: login
+sidebar_position: 10
+---
+# login
+
+Authenticate user with signageOS
+
+
+## Description
+
+Handles user authentication using username/email and password credentials.
+Supports both Auth0 and legacy authentication methods. Stores credentials
+securely in the ~/.sosrc configuration file for subsequent CLI operations.
+
+## Usage
+
+```bash
+sos login [options]
+```
+
+## Options
+
+| Option       | Description                                         |
+| ------------ | --------------------------------------------------- |
+| `--username` | Username or e-mail used for authentication (string) |
+
+## Examples
+
+```bash
+# Interactive login (prompts for username and password)
+sos login
+
+# Login with username specified
+sos login --username user@example.com
+```
+
+## Advanced Usage
+
+### Configuration Management
+
+#### Run Control File
+
+Login credentials are stored in `~/.sosrc` file. For the default profile, it contains:
+
+```ini
+identification=xxxxxxxxxxxxxxxxxxxx
+apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+#### Multiple Profiles
+
+You can manage multiple accounts/configurations using profiles with the `SOS_PROFILE` environment variable or `--profile` argument:
+
+```bash
+# Login with specific profile
+sos login --profile production
+
+# Use profile in subsequent commands
+sos --profile production applet upload
+```
+
+The configuration file uses INI sections for named profiles:
+
+```ini
+[profile production]
+identification=xxxxxxxxxxxxxxxxxxxx
+apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+[profile staging]
+identification=yyyyyyyyyyyyyyyyyyyy
+apiSecurityToken=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+```
+
+#### Environment Variables
+
+You can override login credentials using environment variables:
+
+- **`SOS_API_IDENTIFICATION`**: Override stored identification
+- **`SOS_API_SECURITY_TOKEN`**: Override stored security token  
+- **`SOS_PROFILE`**: Specify which profile to use
+
+Generate tokens at: https://box.signageos.io/settings
+
+### Requirements
+
+- Active account. It can be obtained by manual sign-up in [https://box.signageos.io](https://box.signageos.io)
+- Login account credentials are stored in `~/.sosrc` file
+
+
+## Since
+
+0.3.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
+
+```bash
+# 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
+```

package/docs/organization/get/index.md

@@ -0,0 +1,79 @@
+---
+id: organization-get-index
+title: get
+sidebar_position: 62
+---
+# get
+
+Get detailed information about a specific organization
+
+
+## Description
+
+Retrieves and displays detailed information about a specific organization
+by its UID. If no organization UID is provided, uses the default organization
+or prompts for selection from available organizations.
+
+## Usage
+
+```bash
+sos organization get [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## Examples
+
+```bash
+# Get default organization details
+sos organization get
+
+# Get specific organization by UID
+sos organization get --organization-uid abc123def456
+
+# Force organization selection (skip default)
+sos organization get --no-default-organization
+```
+
+## Since
+
+0.3.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
+
+```bash
+# 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
+
+- [List organizations for selection](../list/)
+- [Organization management commands](../)