---
id: custom-script-generate-index
title: generate
sidebar_position: 1031
---
# generate

Generate a local repository for developing a Custom Script


## Description

Creates a new custom script project with boilerplate code and configuration files.
Generates `.sosconfig.json`, platform directories, and sample implementations.

Requires: name, description, dangerLevel (low/medium/high/critical).

## Usage

```bash
sos custom-script generate [options]
```

## Options

| Option           | Description                                                                                                                                                                                                                   |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--name`         | Custom script name (string)                                                                                                                                                                                                   |
| `--description`  | Custom script description (string)                                                                                                                                                                                            |
| `--danger-level` | Danger level - Can be one of the following: low, medium, high, critical. It represents the danger level of the Custom Script. It should be set according to the potential impact of the Custom Script on the device. (string) |
| `--yes`          | Skip confirmation prompts and use provided values (boolean)                                                                                                                                                                   |

## Examples

```bash
# Interactive generation
sos custom-script generate

# Non-interactive (CI/CD)
sos custom-script generate --name brightness-control --description "Device brightness" --danger-level low --yes
```

## Since

2.2.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

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