---
id: plugin-index
title: plugin
sidebar_position: 1020
---
# plugin

Plugin management


## Description

Plugin management operations for developing and deploying signageOS plugins.

Plugins extend native signageOS features and integrate with system policies.
They run periodically to ensure configuration is consistently enforced on devices.

Plugins must implement `set` and `get` methods.
Upload reads `.sosconfig.json` for configuration.

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


## Examples

```bash
# Generate a new plugin project interactively
sos plugin generate

# Generate plugin with all parameters (non-interactive, suitable for CI/CD)
sos plugin generate --name my-plugin --description "Custom functionality" --yes

# Upload plugin to signageOS platform
sos plugin upload

# Upload plugin non-interactively (for CI/CD pipelines)
sos plugin upload --yes

# Upload with specific organization
sos plugin upload --organization-uid abc123def456
```

## Since

2.6.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 plugin generate`](/cli/plugin/generate/) - Generates a local repository for developing a Plugin
- [`sos plugin upload`](/cli/plugin/upload/) - Uploads current plugin version