sdk-plugin

Everything you need to develop an awesome Strapi plugin

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

@strapi/sdk-plugin

5.3.2

Patch Changes

• #72 9747836 Thanks @boazpoolman! - Fix the routes config for it to be properly registered

5.3.1

Patch Changes

• #81 58bf397 Thanks @innerdvations! - fix: allow any file extension in exports string

5.3.0

Minor Changes

• #70 3a01652 Thanks @jhoward1994! - make react deps compatible with design system

5.2.8

Patch Changes

• #66 2aa1e40 Thanks @Link2Twenty! - fix: registerTrads function

5.2.7

Patch Changes

• #54 fc7192a Thanks @alexandrebodin! - chore: use esm for server code by default

5.2.6

Patch Changes

• 38263ff Thanks @alexandrebodin! - Traget 5.0.0

5.2.5

Patch Changes

• #53 4c9d898 Thanks @alexandrebodin! - Remove unecessary commonjs plugin

• #52 374fd9a Thanks @alexandrebodin! - chore: update readme and some typescript issues

5.2.2

Patch Changes

• #50 08d2f73 Thanks @alexandrebodin! - chore: remove strapi-server file from generate plugin

5.2.1

Patch Changes

• #48 43ab894 Thanks @alexandrebodin! - fix missing commonjs plugin

5.2.0

Minor Changes

• #46 4803fe6 Thanks @Bassel17! - automate install and build for generated plugins

Patch Changes

• #45 345fa5a Thanks @dhoko! - Add support for Node 22

5.1.1

Patch Changes

• #43 845a3b0 Thanks @jhoward1994! - add admin jsconfig when building plugin in javascript

5.1.0

Minor Changes

• #36 f5ddf69 Thanks @innerdvations! - In Strapi projects, generate plugin in plugins path and log config info

Patch Changes

• #38 52c55bf Thanks @innerdvations! - Support commonjs plugins

5.0.2

Patch Changes

• #28 4711257 Thanks @innerdvations! - Use rc versions instead of beta

5.0.1

Patch Changes

• #20 6c829cc Thanks @innerdvations! - Make package manager not strict

• #25 6f9c20b Thanks @innerdvations! - Use correct extensions for javascript projects

• #26 af82a2c Thanks @innerdvations! - fix workflow permissions

5.0.0

Patch Changes

• #16 80d6ab4 Thanks @innerdvations! - Fix build for v5 plugins

• #9 6e705f0 Thanks @joshuaellis! - fix: bin file incorrectly named

• #19 01bc634 Thanks @innerdvations! - Exit pre mode

• #18 7d42be8 Thanks @innerdvations! - Add .tsbuildinfo to gitignore

• 6fb61d9 Thanks @joshuaellis! - various fixes

5.0.0-beta.8

Patch Changes

• 6fb61d9 Thanks @joshuaellis! - various fixes

5.0.0-beta.7

Patch Changes

• #9 6e705f0 Thanks @joshuaellis! - fix: bin file incorrectly named