@signageos/cli 2.4.1 → 2.6.0-rc.0

package/docs/applet/generate/index.md

@@ -0,0 +1,118 @@
+---
+id: applet-generate-index
+title: generate
+sidebar_position: 21
+---
+# generate
+
+Generate new signageOS applet projects with boilerplate code
+
+
+## Description
+
+Creates a new applet project with all necessary configuration files, dependencies,
+and boilerplate code. Supports both TypeScript and JavaScript, multiple bundlers
+(webpack/rspack), various package managers (npm/pnpm/yarn/bun), and includes
+git repository initialization.
+
+## Usage
+
+```bash
+sos applet generate [options]
+```
+
+## Options
+
+| Option             | Description                                                                     | Default |
+| ------------------ | ------------------------------------------------------------------------------- | ------- |
+| `--name`           | Applet name. Match RegExp: /^\w(\w|\d|-)*\w$/ (string)                          |         |
+| `--applet-version` | Applet initial version. Use semantic version (string)                           | `0.0.0` |
+| `--target-dir`     | Directory where will be the applet generated to (string)                        |         |
+| `--git`            | Init applet as git repository "no" (default) or "yes" (string)                  |         |
+| `--packager`       | Use preferred package manager "npm" (default), "pnpm", "yarn" or "bun" (string) |         |
+| `--npm-registry`   | NPM registry URL. If you have your private npm registry (string)                |         |
+| `--language`       | Generate applet with "typescript" or "javascript" source code (string)          |         |
+| `--bundler`        | Generate applet with "webpack" (default) or "rspack" (string)                   |         |
+
+## Examples
+
+```bash
+# Interactive generation with prompts
+sos applet generate
+
+# Generate TypeScript applet with webpack
+sos applet generate --name my-applet --language typescript --bundler webpack
+
+# Generate with custom settings
+sos applet generate --name my-app --target-dir ./projects --git yes --packager pnpm
+
+# Generate with npm registry
+sos applet generate --name my-applet --npm-registry https://registry.npmjs.org/ --packager npm
+
+# Generate applet with specific configuration
+sos applet generate --name my-applet --applet-version 1.0.0 --target-dir ./output --language typescript --bundler webpack --git yes
+```
+
+## Advanced Usage
+
+### Platform Notes
+
+#### Windows Users
+
+There is an unresolved issue with NPX tool on Windows when your username contains spaces (e.g., `John Doe`). To prevent this issue, run the following command in your Command Line (replace `John` with your real first name). Administrator privileges may be required:
+
+```cmd
+npm config set cache "C:\Users\John~1\AppData\Roaming\npm-cache" --global
+```
+
+For more details, see: https://stackoverflow.com/a/58354623/4609457
+
+### Development Workflow
+
+```bash
+# Complete workflow from generation to deployment
+sos applet generate --name my-sample-applet --language typescript --bundler webpack --git yes
+cd my-sample-applet
+
+# Start development with hot reload
+npm start
+
+# Build for production
+npm run build
+
+# Upload to platform
+npm run upload
+```
+
+
+## Since
+
+0.1.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/applet/index.md

@@ -0,0 +1,134 @@
+---
+id: applet-index
+title: applet
+sidebar_position: 20
+---
+# applet
+
+Applet development and management operations
+
+
+## Description
+
+Provides comprehensive commands for the complete applet development lifecycle including
+project generation, development, building, testing, uploading, and deployment to signageOS devices.
+
+## Usage
+
+```bash
+sos applet <subcommand> [options]
+```
+
+## Subcommands
+
+### generate
+
+Generate new signageOS applet projects with boilerplate code
+
+```bash
+sos applet generate [options]
+```
+
+[→ See detailed documentation](/cli/applet/generate/)
+
+### upload
+
+Uploads current applet version
+
+```bash
+sos applet upload [options]
+```
+
+[→ See detailed documentation](/cli/applet/upload/)
+
+### start
+
+Start local applet development server with live preview
+
+```bash
+sos applet start [options]
+```
+
+[→ See detailed documentation](/cli/applet/start/)
+
+### test
+
+Applet test management
+
+```bash
+sos applet test <subcommand> [options]
+```
+
+[→ See detailed documentation](/cli/applet/test/)
+
+### build
+
+Build applet locally for production deployment.
+
+```bash
+sos applet build [options]
+```
+
+[→ See detailed documentation](/cli/applet/build/)
+
+
+## Examples
+
+```bash
+# Create new applet project
+sos applet generate --name my-applet
+
+# Start development server
+sos applet start
+
+# Build for production
+sos applet build
+
+# Upload to platform
+sos applet upload
+```
+
+## Since
+
+0.1.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 applet generate`](/cli/applet/generate/) - Generate new signageOS applet projects with boilerplate code
+- [`sos applet upload`](/cli/applet/upload/) - Uploads current applet version
+- [`sos applet start`](/cli/applet/start/) - Start local applet development server with live preview
+- [`sos applet test`](/cli/applet/test/) - Applet test management
+- [`sos applet build`](/cli/applet/build/) - Build applet locally for production deployment.
+
+## See Also
+
+- [Applet Documentation](https://developers.signageos.io/docs/applets/)

package/docs/applet/start/index.md

@@ -0,0 +1,104 @@
+---
+id: applet-start-index
+title: start
+sidebar_position: 23
+---
+# start
+
+Start local applet development server with live preview
+
+
+## Description
+
+Starts a local development server with hot reload functionality, allowing developers
+to preview their applets in a browser-based emulator. Supports both local development
+and device connection for testing on actual signageOS devices.
+
+:::tip Remarks
+The development server provides a browser-based emulator accessible at http://localhost:8090
+by default. Hot reload automatically refreshes the emulator when source code changes.
+:::
+
+## Usage
+
+```bash
+sos applet start [options]
+```
+
+## Options
+
+| Option                      | Description                                                                                                                                               | Default |
+| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                                                                                          |         |
+| `--organization-uid`        | Organization UID (string)                                                                                                                                 |         |
+| `--port`                    | Port where will the applet run (number)                                                                                                                   | `8090`  |
+| `--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)                                                                              |         |
+| `--hot-reload`              | Enable hot reload and build of applet (boolean)                                                                                                           | `false` |
+| `--server-port`             | The custom server port for local machine server. Default is detected from currently running applet server. (number)                                       |         |
+| `--server-public-url`       | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. (string)                                                  |         |
+| `--force`                   | Force start applet server even if it is already running on a different port. Kill the running server first. (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)                                                               |         |
+
+## Examples
+
+```bash
+# Start development server with default settings
+sos applet start
+
+# Start with custom port and hot reload
+sos applet start --port 8080 --hot-reload
+
+# Start with specific organization
+sos applet start --organization-uid abc123
+
+# Start with custom applet path
+sos applet start --applet-path ./my-applet
+
+# Start with specific entry file
+sos applet start --entry-file-path index.html
+
+# Force restart if server is already running
+sos applet start --force
+
+# Run in detached mode
+sos applet start --detach
+```
+
+## Since
+
+0.1.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
+
+- [Applet Development Documentation](https://developers.signageos.io/docs/applets/connect-to-device-cli/)

package/docs/applet/test/index.md

@@ -0,0 +1,91 @@
+---
+id: applet-test-index
+title: test
+sidebar_position: 24
+---
+# test
+
+Applet test management
+
+
+## Description
+
+Provides commands for testing applets on the signageOS platform, including
+uploading test configurations and running remote tests on actual devices.
+
+## Usage
+
+```bash
+sos applet test <subcommand> [options]
+```
+
+## Subcommands
+
+### upload
+
+Upload applet tests to the signageOS platform
+
+```bash
+sos applet test upload [options]
+```
+
+[→ See detailed documentation](/cli/applet/test/upload/)
+
+### run
+
+Run applet tests on signageOS devices
+
+```bash
+sos applet test run [options]
+```
+
+[→ See detailed documentation](/cli/applet/test/run/)
+
+
+## Examples
+
+```bash
+# Upload test configuration
+sos applet test upload
+
+# Run tests remotely
+sos applet test run
+```
+
+## Since
+
+0.10.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 applet test upload`](/cli/applet/test/upload/) - Upload applet tests to the signageOS platform
+- [`sos applet test run`](/cli/applet/test/run/) - Run applet tests on signageOS devices

package/docs/applet/test/run/index.md

@@ -0,0 +1,82 @@
+---
+id: applet-test-run-index
+title: run
+sidebar_position: 26
+---
+# run
+
+Run applet tests on signageOS devices
+
+
+## Description
+
+Executes previously uploaded applet tests on remote signageOS devices. This command
+triggers test execution and provides real-time feedback on test progress and results.
+Tests can be run on specific devices or across multiple devices for comprehensive testing.
+
+## Usage
+
+```bash
+sos applet test run [options]
+```
+
+## Options
+
+| Option                      | Description                                                                               |
+| --------------------------- | ----------------------------------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                          |
+| `--device-uid`              | Device UID (string)                                                                       |
+| `--organization-uid`        | Organization UID (string)                                                                 |
+| `--applet-uid`              | Applet UID (string)                                                                       |
+| `--test`                    | Specify the test identifiers/files to be run. If not specified, all will be run. (string) |
+| `--yes`                     | Allow to run applet test without confirmation step (boolean)                              |
+
+## Examples
+
+```bash
+# Run all applet tests
+sos applet test run --applet-uid my-applet --device-uid device123
+
+# Run specific tests
+sos applet test run --applet-uid my-applet --device-uid device123 --test "test1,test2"
+
+# Run without confirmation
+sos applet test run --applet-uid my-applet --device-uid device123 --yes
+```
+
+## Since
+
+0.10.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
+
+- [Upload test configuration command](../upload/)

package/docs/applet/test/upload/index.md

@@ -0,0 +1,80 @@
+---
+id: applet-test-upload-index
+title: upload
+sidebar_position: 25
+---
+# upload
+
+Upload applet tests to the signageOS platform
+
+
+## Description
+
+Uploads test files for remote execution on signageOS devices. Test files are
+identified based on the test configuration in package.json and uploaded to
+the platform for automated testing. Supports incremental uploads with
+change detection and confirmation prompts.
+
+## Usage
+
+```bash
+sos applet test upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                                                   |
+| --------------------------- | --------------------------------------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean)                              |
+| `--organization-uid`        | Organization UID (string)                                                                     |
+| `--applet-uid`              | Applet UID (string)                                                                           |
+| `--yes`                     | Allow to upload new applet test or override existing test without confirmation step (boolean) |
+| `--verbose`                 | Outputs all files to upload (boolean)                                                         |
+
+## Examples
+
+```bash
+# Upload applet tests
+sos applet test upload
+
+# Upload tests with confirmation skip
+sos applet test upload --yes
+
+# Upload tests with verbose output
+sos applet test upload --verbose
+
+# Upload tests for specific applet
+sos applet test upload --applet-uid my-applet-uid
+```
+
+## Since
+
+0.10.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
+```