# Using the CLI Plugma comes with a Command Line Interface that supports the following commands. ## Commands

### create

Walks you through creating a Figma plugin or widget. ##### Usage ```package-manager npm create plugma@latest [type?] [framework?] [options] ``` ##### Options - `--template `: Use a specific template - `--dir `: Project directory name - `--add `: Add specific integrations - `--install `: Install dependencies - `--verbose`: Show detailed logging - `--no-ts`: Use JavaScript instead of TypeScript - `--no-add`: Skip add integrations - `--no-install`: Skip dependency installation - `-y, --yes`: Skip all prompts by accepting defaults - `-d, --debug`: Enable debug mode ##### Example ```package-manager # Create a react plugin with the defaults npm create plugma@latest -- plugin react --yes # Add specific integrations during creation npm create plugma@latest -- widget vue --add tailwind vitest prettier # Created project with defaults but don't install depedendencies npm create plugma@latest -- widget svelte --yes --no-install ```

### dev

Start a server to develop your plugin. This command builds the `ui.html` and points it to the dev server making it easier to develop and debug your plugin. ##### Usage ```package-manager npm run dev [options] ``` ##### Options - `-p`, `--port`: Specify a port number for the plugin preview. - `-o`, `--output`: Specify an output dir, default is `dist`. - `-m`, `--mode`: Specify a mode. - `--no-websockets`: Disable WebSockets. - `--dock-plugin`: Minimise and dock the plugin in the Figma UI. ##### Example ```package-manager # Start development server on port 3000 npm run dev -- -p 3000 ```

### build

Create a build before publishing. This command compiles and bundles your plugin, preparing it for distribution. ##### Usage ```package-manager npm run build [options] ``` ##### Options - `-w`, `--watch`: Watch for changes and rebuild automatically. - `-o`, `--output`: Specify an output dir, default is `dist`. - `-m`, `--mode`: Specify a mode. ##### Example ```package-manager # Build the plugin npm run build # Build and watch for changes npm run build -- -w ```

### release

Build the plugin and release to GitHub. This command automates creating a new GitHub release with your latest changes. If no version is specified, it will automatically update the `plugma.pluginVersion` field in `package.json`. ```package-manager npm run release [version] [options] ``` ##### Version - `alpha`, `beta`, `stable` or an integer (optional) ##### Options - `--title`: Custom title for the release. - `--notes`: Add release notes. - `--prefix`: Specify a prefix to prepend to the version number (e.g., "figma-plugin"). - `-o`, `--output`: Specify an output dir, default is `dist`. ##### Example ```package-manager # Increment the next stable version npm run release # Release a beta version with custom title and notes npm run release -- beta -t "New feature" -n "This release includes new features X and Y" # Release with a custom prefix (creates tag: figma-plugin@1) npm run release -- --prefix "figma-plugin" --title "Plugin Release" # Release alpha version with custom prefix (creates tag: plugin@2-alpha.0) npm run release -- alpha --prefix "plugin" --title "Alpha Release" ```

### add

Adds support for various integrations to your project, including testing frameworks, UI libraries, and other development tools. ##### Usage ```package-manager npm create plugma@latest add ``` ##### Integration - `playwright` - `vitest` - `tailwind` - `shadcn` - `eslint` - `prettier` ##### Options - `--install `: Install dependencies - `--no-install`: Skip dependency installation - `--verbose`: Show detailed logs - `--debug`: Enable debug mode ##### Examples ```package-manager # Add tailwind with detected package manager npm create plugma@latest add tailwind --install # Add eslint with specific package manager npm create plugma@latest add eslint --install pnpm # Add playwright without installing dependencies npm create plugma@latest add playwright --no-install ```

## Installing globally If you'd prefer to use the CLI globally you can install it using the following. ```package-manager npm install plugma -g ```