Skip to main content

generate

Generates a local repository for developing a Plugin

Description

Generates a local repository for developing a Plugin with boilerplate code and configuration files. Sets up complete development environment with necessary dependencies and project structure.

Runs interactively by default or non-interactively with --yes option. Requires Git to be installed and accessible.

Usage

sos plugin generate [options]

Options

OptionDescription
--namePlugin name (string)
--descriptionPlugin description (string)
--yesSkip confirmation prompts and use provided values (boolean)

Examples

# Generate plugin project interactively
sos plugin generate

# Generate non-interactively (suitable for CI/CD)
sos plugin generate --name my-plugin --description "My custom plugin" --yes

Since

2.6.0

Global Options

All commands support the following global options:

OptionAliasDescription
--help-hDisplay help information for any command
--version-vDisplay the installed version of the CLI
--api-url-uOverride the API URL for REST requests
--profileUse a specific profile from ~/.sosrc config

Examples

# 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