---
id: applet-index
title: applet
sidebar_position: 1000
---
# 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/)