create-stratos-plugin

Scaffold a new Stratos plugin project in seconds.

Usage

pnpx create-stratos-plugin

Or with a name:

pnpx create-stratos-plugin my-plugin

The CLI walks you through the setup — plugin name, author, type (airline or user), and whether to include a background module.

Non-Interactive

Skip prompts by passing all options as flags:

pnpx create-stratos-plugin \
  --name "Flight Logger" \
  --id flight-logger \
  --description "Logs flight events to a file" \
  --author "Jane Doe" \
  --author-id jane-doe \
  --type airline \
  --background false

What You Get

my-plugin/
├── plugin.json            # Plugin manifest
├── package.json           # Dependencies and scripts
├── vite.config.ts         # Build config with SDK preset
├── tsconfig.json          # TypeScript config
├── src/
│   ├── ui/
│   │   ├── index.tsx      # Plugin UI entry point
│   │   └── global.css     # Tailwind CSS
│   └── background/        # (if selected)
│       └── index.ts       # Background module entry
└── assets/
    ├── icon-light.svg     # Sidebar icon (light theme)
    └── icon-dark.svg      # Sidebar icon (dark theme)

Development

After scaffolding:

cd my-plugin
pnpm install
pnpm dev

Make sure Stratos is running with developer mode enabled (--dev flag). Your plugin auto-connects and appears in the sidebar with live reload.

Learn More

• Plugin SDK Documentation
• Getting Started Guide
• @skyvexsoftware/stratos-sdk

License

MIT — Skyvex Software