---
id: custom-script-index
title: custom-script
sidebar_position: 1010
---
# custom-script

Custom Script management


## Description

Custom Scripts management for advanced device operations.

Allows sending OS-specific scripts with native API access to signageOS devices.
Supports JavaScript (browser), PowerShell (Windows), Bash/Shell (Linux/Android).

## 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 project
sos custom-script generate

# Upload 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

- [Documentation](https://developers.signageos.io/docs/custom-scripts/)
- [Config File](https://developers.signageos.io/docs/custom-scripts/#config-file)