Skip to content

CLI toolkit for developing a Strapi plugin

License

Notifications You must be signed in to change notification settings

strapi/sdk-plugin

Folders and files

NameName
Last commit message
Last commit date
Feb 19, 2025
Feb 11, 2025
May 7, 2024
May 13, 2024
Feb 11, 2025
May 7, 2024
May 7, 2024
May 8, 2024
May 7, 2024
May 7, 2024
May 7, 2024
May 7, 2024
May 23, 2024
May 8, 2024
May 7, 2024
Feb 19, 2025
May 7, 2024
May 7, 2024
Sep 12, 2024
May 7, 2024
Feb 19, 2025
May 7, 2024
Dec 10, 2024
May 7, 2024
May 7, 2024
May 7, 2024

Repository files navigation

sdk-plugin

Everything you need to develop an awesome Strapi plugin


Chat on Discord


sdk-plugin is a set of command line utilities for developing a Strapi plugin

Getting Started

If you're setting up a brand new plugin we recommend you use the init command to get started:

npx @strapi/sdk-plugin@latest init my-plugin

That will create a directory with all your plugin project files.

Once your project has been installed, several commands are available to you.

Commands

All of the following comands have the following options available:

-- -d, --debug – Enable debugging mode with verbose logs (default: false) -- --silent – Don't log anything (default: false) -- -h, --help – Display help for command

init [path]

Creates a new plugin at the given path.

build

Builds your current package based on the configuration in your package.json.

  • --minify – minifies the output (default false).
  • --sourcemap – generates sourcemaps for the output (default true).
yarn run build

watch

Watch & compile your strapi plugin for local development.

yarn run watch

watch:link

Recompiles your plugin automatically on changes and runs yalc push --publish

yarn run watch:link

verify

Verifies the output of your plugin before publishing it

yarn run verify