@signageos/cli 2.4.0 → 2.5.0

package/docs/autocomplete/index.md

@@ -0,0 +1,92 @@
+---
+id: autocomplete-index
+title: autocomplete
+sidebar_position: 70
+---
+# autocomplete
+
+CLI auto-completion management
+
+
+## Description
+
+Provides commands for installing and managing shell auto-completion for the signageOS CLI.
+Auto-completion enhances developer productivity by providing intelligent command and
+sub-command suggestions in supported shells (bash, zsh, fish).
+
+## Usage
+
+```bash
+sos autocomplete <subcommand> [options]
+```
+
+## Subcommands
+
+### install
+
+Install command auto-completion for bash/zsh shells
+
+```bash
+sos autocomplete install [options]
+```
+
+[→ See detailed documentation](install/)
+
+### uninstall
+
+Uninstall command auto-completion for bash/zsh shells
+
+```bash
+sos autocomplete uninstall [options]
+```
+
+[→ See detailed documentation](uninstall/)
+
+
+## Examples
+
+```bash
+# Install auto-completion for current shell
+sos autocomplete install
+
+# Uninstall auto-completion
+sos autocomplete uninstall
+```
+
+## Since
+
+2.4.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 autocomplete install`](install/) - Install command auto-completion for bash/zsh shells
+- [`sos autocomplete uninstall`](uninstall/) - Uninstall command auto-completion for bash/zsh shells

package/docs/autocomplete/install/index.md

@@ -0,0 +1,120 @@
+---
+id: autocomplete-install-index
+title: install
+sidebar_position: 71
+---
+# install
+
+Install command auto-completion for bash/zsh shells
+
+
+## Description
+
+Enables auto-completion functionality for the signageOS CLI in supported shells.
+This command adds auto-completion scripts and configuration to the user's shell
+profile, allowing tab completion for commands and sub-commands.
+
+## Usage
+
+```bash
+sos autocomplete install [options]
+```
+
+## Examples
+
+```bash
+# Install auto-completion
+sos autocomplete install
+```
+
+## Advanced Usage
+
+### Shell Compatibility
+
+signageOS CLI autocomplete supports:
+- **Zsh** (.zshrc)
+- **Bash** (.bashrc, .bash_profile)
+- **Fish** (.config/fish/config.fish)
+
+### Setup Process
+
+1. **Install completion script**: Adds script to home directory
+2. **Configure shell**: Adds source line to shell configuration file
+3. **Activate immediately**: Source the completion script without restart
+
+```bash
+# Install and activate immediately
+sos autocomplete install
+source ~/.sos-completion.sh
+```
+
+### Usage Examples
+
+```bash
+# Show all top-level commands
+sos [TAB]
+
+# Show all applet subcommands  
+sos applet [TAB]
+
+# Autocomplete partial commands
+sos applet up[TAB]    # Completes to "sos applet upload"
+sos org l[TAB]        # Completes to "sos organization list"
+```
+
+### Troubleshooting
+
+If autocomplete isn't working:
+
+```bash
+# Verify installation
+ls -la ~/.sos-completion.sh
+
+# Check shell configuration
+grep "sos-completion" ~/.zshrc  # or ~/.bashrc
+
+# Reload shell configuration
+source ~/.zshrc  # or ~/.bashrc
+
+# Reinstall if needed
+sos autocomplete uninstall
+sos autocomplete install
+```
+
+
+## Since
+
+2.4.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
+
+- [Uninstall auto-completion command](../uninstall/)

package/docs/autocomplete/uninstall/index.md

@@ -0,0 +1,65 @@
+---
+id: autocomplete-uninstall-index
+title: uninstall
+sidebar_position: 72
+---
+# uninstall
+
+Uninstall command auto-completion for bash/zsh shells
+
+
+## Description
+
+Removes the signageOS CLI auto-completion functionality from the user's shell configuration.
+This command reverses the changes made by the install command, removing auto-completion
+scripts and configuration entries from shell profile files.
+
+## Usage
+
+```bash
+sos autocomplete uninstall [options]
+```
+
+## Examples
+
+```bash
+# Uninstall auto-completion
+sos autocomplete uninstall
+```
+
+## Since
+
+2.4.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
+
+- [Install auto-completion command](../install/)

package/docs/custom-script/generate/index.md

@@ -0,0 +1,66 @@
+---
+id: custom-script-generate-index
+title: generate
+sidebar_position: 51
+---
+# generate
+
+Generate a local repository for developing a Custom Script
+
+
+## Description
+
+Creates a new custom script project with boilerplate code and configuration files.
+This command sets up a complete development environment for custom script development,
+including necessary dependencies and project structure.
+
+## Usage
+
+```bash
+sos custom-script generate [options]
+```
+
+## Examples
+
+```bash
+# Generate custom script project
+sos custom-script generate
+```
+
+## Since
+
+2.2.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
+
+- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [Upload custom script command](../upload/)

package/docs/custom-script/index.md

@@ -0,0 +1,96 @@
+---
+id: custom-script-index
+title: custom-script
+sidebar_position: 50
+---
+# 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
+
+```bash
+sos custom-script <subcommand> [options]
+```
+
+## Subcommands
+
+### upload
+
+Upload custom script to the signageOS platform
+
+```bash
+sos custom-script upload [options]
+```
+
+[→ See detailed documentation](upload/)
+
+### generate
+
+Generate a local repository for developing a Custom Script
+
+```bash
+sos custom-script generate [options]
+```
+
+[→ See detailed documentation](generate/)
+
+
+## Examples
+
+```bash
+# 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:
+
+| 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 custom-script upload`](upload/) - Upload custom script to the signageOS platform
+- [`sos custom-script generate`](generate/) - Generate a local repository for developing a Custom Script
+
+## See Also
+
+- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)

package/docs/custom-script/upload/index.md

@@ -0,0 +1,78 @@
+---
+id: custom-script-upload-index
+title: upload
+sidebar_position: 52
+---
+# upload
+
+Upload custom script to the signageOS platform
+
+
+## Description
+
+Uploads custom script code and configuration to the signageOS platform based on
+the .sosconfig.json configuration file. Custom Scripts enable advanced device
+functionality beyond standard applets, including system-level operations and
+device-specific configurations for multiple platforms.
+
+## Usage
+
+```bash
+sos custom-script upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## Examples
+
+```bash
+# Upload custom script from current directory
+sos custom-script upload
+
+# Upload with specific organization
+sos custom-script upload --organization-uid abc123def456
+```
+
+## Since
+
+1.8.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
+
+- [Custom Scripts Documentation](https://developers.signageos.io/docs/custom-scripts/)
+- [Generate custom script project](../generate/)
+- [Custom Script management commands](../)

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/)