Create CLI

create-streamdeck-react bootstraps a complete Stream Deck plugin project using @fcannizzaro/streamdeck-react.

Usage

bun create streamdeck-react

You can also pass the target directory directly:

npm create streamdeck-react@latest my-plugin

What It Asks For

• Project directory
• Plugin name
• Plugin UUID
• Author
• Description and category
• Package manager
• Starter example
• Supported Stream Deck platforms (mac, windows)
• Native targets
• Whether to use React Compiler

Included Starter Examples

• minimal -- one action with local state
• counter -- keys, timer, settings, and encoder examples
• zustand -- shared module-scope state
• jotai -- plugin wrapper plus shared atom state
• pokemon -- React Query and remote image fetching

Generated Files

The scaffold includes:

• a seed manifest.json for the initial streamdeck link step (overwritten on first build by the auto-generation pipeline)
• a bundler config (vite.config.ts) with native targets and manifest plugin option
• starter src/ files for the selected example, with defineAction({ info }) metadata for manifest auto-generation
• default SVG icons for the plugin and each action
• an Inter-Regular.ttf font ready for createPlugin() via googleFont("Inter")

After Generation

Install dependencies, build once, then load the generated .sdPlugin into the Stream Deck app.

npm install
npm run build