Feature Showcase: The Vendure CLI

Building robust e-commerce applications means following best practices, which often involves creating a consistent structure across the entire project, implying writing boilerplate code.

This is where the Vendure CLI tool comes in, made to streamline this process by automating common development and setup tasks.

Key Features

It can analyze your project to correctly modify your codebase when adding new functionality.

• Adding Features: The add command scaffolds new features and correctly updates your project's modules, plugins, and configuration files.
• Interactive and Non-Interactive Modes: Use the interactive mode for a guided experience during development or the non-interactive mode allowing for AI agentic use and calls through the Vendure MCP.
• Database migrations: The migrate command provides a dedicated interface for generating, running, and reverting database migrations.

Use-Cases

The CLI can be used to automate a wide range of common tasks. Here are some examples of what you can do:

Scaffold a new plugin from scratch. This command creates the entire directory structure and necessary files for a new plugin, giving you a starting point for your custom functionality.

Add a new database entity to an existing plugin. You can add a new database entity and use flags to include features like custom fields and translations automatically.

Manage database migrations. The migrate command simplifies database schema management, allowing you to generate, run, and revert migrations.

You can find out more about the CLI on our documentation page for it:

Vendure Documentation: CLI

Further Reading

• Plugin Development
• Database Migrations
• Custom Fields