The Vendure CLI is a command-line tool for boosting your productivity as a developer.
Currently, it provides functionality for rapidly scaffolding a new plugin, and in future we will be expanding the capabilities to include other common tasks.
The Vendure CLI package was introduced with Vendure v2.1.0
You can install the CLI locally in your Vendure project, or you can run it without installation using
npx. The advantage of installing locally is that you can more easily control the installed version, and you can reference the CLI using the
npm install -D @vendure/cli
yarn add -D @vendure/cli
and then from your project directory you can run:
Running without installation
If you want to use the Vendure CLI without installing it in your project, you can run
npx @vendure/cli --version
Scaffold a new plugin
The Vendure CLI can be used to quickly scaffold a new plugin.
- Navigate to your plugins directory
- Run the
vendure new plugin
- Answer the questions to configure your new plugin