Skip to main content

​
Introduction

The EverShop CLI provides a set of commands to manage your e-commerce store from the command line. It handles development workflows, production builds, deployment, user management, and theme customization.

​
Installation

The CLI is included with the EverShop package. When you install EverShop, the evershop command becomes available: 
npm install @evershop/evershop
The CLI is accessible through the evershop binary: 
evershop <command> [options]

​
Available Commands

​
Development

  • evershop dev - Start the development server with hot reload
  • evershop build - Build the application for production
  • evershop start - Start the production server

​
Setup & Installation

  • evershop install - Run the interactive setup wizard

​
User Management

  • evershop user:create - Create a new admin user
  • evershop user:changePassword - Change an admin user’s password

​
Theme Management

  • evershop theme:create - Create a new theme
  • evershop theme:active - Activate an existing theme
  • evershop theme:twizz - Create theme overrides for components

​
Development Tools

  • evershop seed - Seed demo data (products, categories, pages, etc.)

​
Basic Usage

​
Quick Start Development

# Install your store
evershop install

# Start development server
evershop dev

​
Production Deployment

# Build for production
evershop build

# Start production server
evershop start

​
Environment Variables

The CLI respects environment variables set in your .env file or system environment:
  • DB_HOST - Database host
  • DB_PORT - Database port
  • DB_NAME - Database name
  • DB_USER - Database user
  • DB_PASSWORD - Database password
  • DB_SSLMODE - SSL mode (require/disable)

​
Global Behavior

​
Error Handling

All CLI commands include comprehensive error handling:
  • Uncaught exceptions are logged
  • Unhandled promise rejections are captured
  • Detailed error messages are provided

​
Configuration

The CLI uses the Node.js config package to manage configuration:
  • Configuration files are located in config/
  • Default configuration is in config/default.json
  • Environment-specific configs override defaults

​
Getting Help

Most commands support the --help flag: 
evershop user:create --help

​
Next Steps

Development Server

Learn about the development workflow

Production Build

Build your store for production

User Management

Manage admin users

Theme Commands

Customize your store’s appearance

Build docs developers (and LLMs) love

Get started for freeTalk to us