@signageos/cli 2.4.1 → 2.6.0-rc.0

package/docs/applet/upload/index.md

@@ -0,0 +1,131 @@
+---
+id: applet-upload-index
+title: upload
+sidebar_position: 25
+---
+# upload
+
+Uploads current applet version
+
+
+## Description
+
+Uploads the current applet version to the signageOS platform, making it available
+for deployment to devices. The command supports both single-file and multi-file applets,
+with automatic version management and conflict detection.
+
+The upload process validates package.json requirements, creates or updates applet versions,
+and handles file packaging according to .sosignore, .npmignore, and .gitignore rules.
+
+## Usage
+
+```bash
+sos applet upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                                                                                                                       |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--applet-path`             | Path to the applet file or the project folder depending on the entry file. Relative to the command or absolute. (string)                                          |
+| `--entry-file-path`         | Path to the applet entry file. Relative to the command or absolute. (string)                                                                                      |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                                                                                                  |
+| `--organization-uid`        | Organization UID (string)                                                                                                                                         |
+| `--applet-uid`              | Applet UID (string)                                                                                                                                               |
+| `--update-package-config`   | Force updating package.json with sos.appletUid value of created applet. It's useful when appletUid is passed using SOS_APPLET_UID environment variable. (boolean) |
+| `--yes`                     | Allow to upload new applet or override existing version without confirmation step (boolean)                                                                       |
+| `--verbose`                 | Outputs all files to upload (boolean)                                                                                                                             |
+
+## Examples
+
+```bash
+# Upload applet from current directory
+sos applet upload
+
+# Upload with specific applet path
+sos applet upload --applet-path ./dist
+
+# Upload with custom entry file
+sos applet upload --entry-file-path src/main.js
+
+# Upload with organization override
+sos applet upload --organization-uid abc123def456
+
+# Skip confirmation prompts
+sos applet upload --yes
+
+# Verbose output with detailed file information
+sos applet upload --verbose
+
+# Update package.json with new applet UID
+sos applet upload --update-package-config
+```
+
+## Advanced Usage
+
+### Environment Variables
+
+You can override certain values using environment variables:
+
+- **`SOS_APPLET_UID`**: Specify applet UID to upload to (overrides `sos.appletUid` in package.json)
+- **`SOS_APPLET_VERSION`**: Specify applet version to upload (overrides `version` in package.json)
+
+```bash
+# Upload to specific applet using environment variable
+SOS_APPLET_UID=abc123def456 sos applet upload
+
+# Upload with specific version
+SOS_APPLET_VERSION=1.2.3 sos applet upload
+```
+
+### File Handling
+
+- **Applet Creation**: If applet doesn't exist, it will be created automatically
+- **Version Management**: Applet version is read from `package.json`
+- **Applet UID Storage**: Generated applet UID is stored in `package.json` under `sos.appletUid`
+- **Ignore Files**: File exclusion priority (top to bottom): `.sosignore` > `.npmignore` > `.gitignore`
+- **Single Ignore File**: Only one ignore file is used, or none
+
+### Alternative Upload Methods
+
+```bash
+# Upload using npm script (recommended)
+npm run upload
+
+# Upload all files in applet directory (deprecated method)
+sos applet upload --applet-path=dist/index.html
+# Note: This will upload only the specified file and remove others from servers
+```
+
+
+## Since
+
+0.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
+```

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](/cli/autocomplete/install/)
+
+### uninstall
+
+Uninstall command auto-completion for bash/zsh shells
+
+```bash
+sos autocomplete uninstall [options]
+```
+
+[→ See detailed documentation](/cli/autocomplete/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`](/cli/autocomplete/install/) - Install command auto-completion for bash/zsh shells
+- [`sos autocomplete uninstall`](/cli/autocomplete/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](/cli/custom-script/upload/)
+
+### generate
+
+Generate a local repository for developing a Custom Script
+
+```bash
+sos custom-script generate [options]
+```
+
+[→ See detailed documentation](/cli/custom-script/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`](/cli/custom-script/upload/) - Upload custom script to the signageOS platform
+- [`sos custom-script generate`](/cli/custom-script/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](../)