@signageos/cli 2.4.1 → 2.6.0-rc.0

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](../)

package/docs/organization/index.md

@@ -0,0 +1,105 @@
+---
+id: organization-index
+title: organization
+sidebar_position: 60
+---
+# organization
+
+Organization management operations
+
+
+## Description
+
+Provides commands to manage signageOS organizations including listing available organizations,
+retrieving organization details, and setting default organization for CLI operations.
+
+## Usage
+
+```bash
+sos organization <subcommand> [options]
+```
+
+## Subcommands
+
+### list
+
+List organizations for logged account
+
+```bash
+sos organization list [options]
+```
+
+[→ See detailed documentation](/cli/organization/list/)
+
+### get
+
+Get detailed information about a specific organization
+
+```bash
+sos organization get [options]
+```
+
+[→ See detailed documentation](/cli/organization/get/)
+
+### set-default
+
+Set a default organization for CLI operations
+
+```bash
+sos organization set-default [options]
+```
+
+[→ See detailed documentation](/cli/organization/set-default/)
+
+
+## Examples
+
+```bash
+# List all organizations
+sos organization list
+
+# Get specific organization details
+sos organization get --organization-uid abc123
+
+# Set default organization
+sos organization set-default
+```
+
+## 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
+```
+
+
+## Related Commands
+
+- [`sos organization list`](/cli/organization/list/) - List organizations for logged account
+- [`sos organization get`](/cli/organization/get/) - Get detailed information about a specific organization
+- [`sos organization set-default`](/cli/organization/set-default/) - Set a default organization for CLI operations

package/docs/organization/list/index.md

@@ -0,0 +1,65 @@
+---
+id: organization-list-index
+title: list
+sidebar_position: 61
+---
+# list
+
+List organizations for logged account
+
+
+## Description
+
+Retrieves and displays all organizations that the currently authenticated
+account has access to. This command helps users understand which organizations
+they can work with and select appropriate targets for other CLI operations.
+
+## Usage
+
+```bash
+sos organization list [options]
+```
+
+## Examples
+
+```bash
+# List all accessible organizations
+sos organization list
+```
+
+## 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
+
+- [Get detailed organization information](../get/)

package/docs/organization/set-default/index.md

@@ -0,0 +1,74 @@
+---
+id: organization-set-default-index
+title: set-default
+sidebar_position: 63
+---
+# set-default
+
+Set a default organization for CLI operations
+
+
+## Description
+
+Sets a default organization that will be used automatically in subsequent CLI commands
+that require an organization context. This eliminates the need to specify the organization
+UID for each command. The default organization is stored in the ~/.sosrc configuration file.
+
+:::tip Remarks
+The default organization can be overridden using the SOS_ORGANIZATION_UID environment variable
+or by using the --organization-uid flag in individual commands.
+:::
+
+## Usage
+
+```bash
+sos organization set-default [options]
+```
+
+## Options
+
+| Option               | Description               |
+| -------------------- | ------------------------- |
+| `--organization-uid` | Organization UID (string) |
+
+## Examples
+
+```bash
+# Interactive selection of default organization
+sos organization set-default
+
+# Set specific organization as default
+sos organization set-default --organization-uid abc123
+```
+
+## Since
+
+1.0.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/plugin/generate/index.md

@@ -0,0 +1,43 @@
+---
+id: plugin-generate-index
+title: generate
+sidebar_position: 0
+---
+# generate
+
+Generates a local repository for developing a Plugin
+
+
+## Usage
+
+```bash
+sos plugin generate [options]
+```
+
+## 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/plugin/index.md

@@ -0,0 +1,72 @@
+---
+id: plugin-index
+title: plugin
+sidebar_position: 0
+---
+# plugin
+
+Plugin management
+
+
+## Usage
+
+```bash
+sos plugin <subcommand> [options]
+```
+
+## Subcommands
+
+### generate
+
+Generates a local repository for developing a Plugin
+
+```bash
+sos plugin generate [options]
+```
+
+[→ See detailed documentation](/cli/plugin/generate/)
+
+### upload
+
+Uploads current plugin version
+
+```bash
+sos plugin upload [options]
+```
+
+[→ See detailed documentation](/cli/plugin/upload/)
+
+
+## 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 plugin generate`](/cli/plugin/generate/) - Generates a local repository for developing a Plugin
+- [`sos plugin upload`](/cli/plugin/upload/) - Uploads current plugin version

package/docs/plugin/upload/index.md

@@ -0,0 +1,50 @@
+---
+id: plugin-upload-index
+title: upload
+sidebar_position: 0
+---
+# upload
+
+Uploads current plugin version
+
+
+## Usage
+
+```bash
+sos plugin upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## 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/runner/generate/index.md

@@ -0,0 +1,43 @@
+---
+id: runner-generate-index
+title: generate
+sidebar_position: 0
+---
+# generate
+
+Generates a local repository for developing a Runner
+
+
+## Usage
+
+```bash
+sos runner generate [options]
+```
+
+## 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
+```