Plugin CLI reference

🏗 Work in progress

The content of this page might not be fully up-to-date with Strapi 5 yet.

The Plugin CLI is set of commands provided by the package @strapi/sdk-plugin orientated around developing plugins to use them as local plugins or to publish them on NPM and/or submit them to the Marketplace.

The present documentation lists the available Plugin CLI commands. The associated guide illustrates how to use these commands to create a plugin from scratch, link it to an existing project, and publish it.

npx @strapi/sdk-plugin init

Create a new plugin at a given path.

npx @strapi/sdk-plugin init

Arguments	Type	Description	Default
path	string	Path to the plugin	./src/plugins/my-plugin

Option	Type	Description	Default
-d, --debug	-	Enable debugging mode with verbose logs	false
--silent	-	Do not log anything	false

strapi-plugin build

Bundle the strapi plugin for publishing.

strapi-plugin build

Option	Type	Description	Default
--force	string	Automatically answer "yes" to all prompts, including potentially destructive requests, and run non-interactively.	-
-d, --debug	-	Enable debugging mode with verbose logs	false
--silent	-	Do not log anything	false
--minify	-	Minify the output	true
--sourcemaps	-	Produce sourcemaps	false

strapi-plugin watch:link

Recompiles the plugin automatically on changes and runs yalc push --publish.

strapi-plugin watch:link

Option	Type	Description	Default
-d, --debug	-	Enable debugging mode with verbose logs	false
--silent	-	Do not log anything	false

strapi-plugin watch

Watch and compile the Strapi plugin for local development.

strapi-plugin watch

Option	Type	Description	Default
-d, --debug	-	Enable debugging mode with verbose logs	false
--silent	-	Do not log anything	false

strapi-plugin verify

Verify the output of the plugin before publishing it.

strapi-plugin verify

Option	Type	Description	Default
-d, --debug	-	Enable debugging mode with verbose logs	false
--silent	-	Do not log anything	false