@signageos/cli 2.4.1 → 2.6.0-rc.0

package/docs/device/connect/index.md

@@ -0,0 +1,148 @@
+---
+id: device-connect-index
+title: connect
+sidebar_position: 31
+---
+# connect
+
+Connect device to local development server
+
+
+## Description
+
+Establishes a connection between a signageOS device and the local development environment,
+allowing real-time testing and debugging of applets during development. Supports both
+local network (LAN) and forward server connections for different network configurations.
+
+The command sets up a development server and configures the device to load the applet
+from the local machine, enabling hot reload and live debugging capabilities.
+
+## Usage
+
+```bash
+sos device connect [options]
+```
+
+## Options
+
+| Option                      | Description                                                                                                                                                            | Default |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                                                                                                       |         |
+| `--organization-uid`        | Organization UID (string)                                                                                                                                              |         |
+| `--device-uid`              | Device UID (string)                                                                                                                                                    |         |
+| `--applet-uid`              | Applet UID (string)                                                                                                                                                    |         |
+| `--server-public-url`       | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. (string)                                                               |         |
+| `--server-port`             | The custom server port for local machine server. Default is detected from currently running applet server. (number)                                                    |         |
+| `--force`                   | Force start applet server even if it is already running on a different port. Kill the running server first. (boolean)                                                  |         |
+| `--use-forward-server`      | Use forward server to connect to the device instead of the local network (LAN). It's useful when the device is not in the same network as the local machine. (boolean) |         |
+| `--detach`                  | Detach the applet HTTP server process from the terminal. Useful when want to run more commands reusing the same http server for current applet. (boolean)              | `false` |
+| `--forward-server-url`      | Url of forward server to connect to the device instead of the local network (LAN). (string)                                                                            |         |
+| `--hot-reload`              | Enable hot reload and build of applet (boolean)                                                                                                                        | `false` |
+| `--applet-path`             | Path to the applet file or the project folder depending on the entry file. Relative to the command or absolute. (string)                                               |         |
+
+## Examples
+
+```bash
+# Connect device with basic configuration
+sos device connect --device-uid device123 --applet-uid my-applet
+
+# Connect with custom server port
+sos device connect --device-uid device123 --server-port 8080
+
+# Connect using forward server (for remote devices)
+sos device connect --device-uid device123 --use-forward-server
+
+# Connect with hot reload enabled
+sos device connect --device-uid device123 --hot-reload
+
+# Connect with custom organization
+sos device connect --device-uid device123 --organization-uid org456
+
+# Connect with custom public URL
+sos device connect --device-uid device123 --server-public-url https://my-domain.com
+
+# Connect and run in background
+sos device connect --device-uid device123 --detach
+
+# Force connection (terminate existing servers)
+sos device connect --device-uid device123 --force
+```
+
+## Advanced Usage
+
+### Prerequisites
+
+Before connecting a device:
+
+1. **Build and upload applet**: The applet must be built and uploaded to the platform at least once
+2. **Device configuration**: Ensure the device is properly configured and accessible
+3. **Network access**: Device should be accessible via local network or use `--use-forward-server` for remote access
+
+### Development Workflow
+
+```bash
+# Typical development workflow
+sos applet generate --name my-applet
+cd my-applet
+npm run build
+sos applet upload
+sos device connect --device-uid device123 --hot-reload
+```
+
+### Network Considerations
+
+- **Local Network (LAN)**: Default behavior, requires device and development machine on same network
+- **Forward Server**: Use `--use-forward-server` when device is remote or behind different network
+- **Custom Forward Server**: Override with `--forward-server-url` for private deployments
+- **Public URL**: Set `--server-public-url` when behind reverse proxy or custom domain
+
+## Configuration Tips
+
+```bash
+# Update package.json with applet UID when created
+sos device connect --device-uid device123 --update-package-config
+
+# Use custom ports for development
+sos device connect --device-uid device123 --server-port 8080
+
+# Run server in background for multiple sessions
+sos device connect --device-uid device123 --detach
+```
+
+
+## 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
+```
+
+
+## See Also
+
+- [Device Connection and Development Documentation](https://developers.signageos.io/docs/applets/connect-to-device-cli/)

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](/cli/device/set-content/)
+
+### power-action
+
+Perform power action on device
+
+```bash
+sos device power-action <actionType> [options]
+```
+
+[→ See detailed documentation](/cli/device/power-action/)
+
+### connect
+
+Connect device to local development server
+
+```bash
+sos device connect [options]
+```
+
+[→ See detailed documentation](/cli/device/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`](/cli/device/set-content/) - Deploy applet to device
+- [`sos device power-action`](/cli/device/power-action/) - Perform power action on device
+- [`sos device connect`](/cli/device/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,170 @@
+---
+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](/cli/applet/)
+
+#### `sos custom-script`
+
+Custom Script management
+
+**Available commands**: `sos custom-script upload`, `sos custom-script generate`
+
+[→ See detailed documentation](/cli/custom-script/)
+
+### Authentication
+
+#### `sos login`
+
+Authenticate user with signageOS
+
+[→ See detailed documentation](/cli/login/)
+
+### Management
+
+#### `sos organization`
+
+Organization management operations
+
+**Available commands**: `sos organization list`, `sos organization get`, `sos organization set-default`
+
+[→ See detailed documentation](/cli/organization/)
+
+#### `sos timing`
+
+Timing management
+
+**Available commands**: `sos timing list`
+
+[→ See detailed documentation](/cli/timing/)
+
+#### `sos device`
+
+Device management
+
+**Available commands**: `sos device set-content`, `sos device power-action`, `sos device connect`
+
+[→ See detailed documentation](/cli/device/)
+
+### Tools
+
+#### `sos autocomplete`
+
+CLI auto-completion management
+
+**Available commands**: `sos autocomplete install`, `sos autocomplete uninstall`
+
+[→ See detailed documentation](/cli/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`](/cli/applet/) - Applet development and management operations
+- [`sos login`](/cli/login/) - Authenticate user with signageOS
+- [`sos organization`](/cli/organization/) - Organization management operations
+- [`sos timing`](/cli/timing/) - Timing management
+- [`sos device`](/cli/device/) - Device management
+- [`sos custom-script`](/cli/custom-script/) - Custom Script management
+- [`sos plugin`](/cli/plugin/) - Plugin management
+- [`sos runner`](/cli/runner/) - Runner management
+- [`sos autocomplete`](/cli/autocomplete/) - CLI auto-completion management
+
+## See Also
+
+- [CLI Setup](https://developers.signageos.io/docs/cli-setup/)