packages/cli/README.md
CLI for managing Spree Commerce projects — Docker-based dev stack, generators, API keys, and a gh-style Admin API client.
Automatically included in projects created with create-spree-app. Can also be installed standalone:
npm install -g @spree/cli
spree <command>
Run from your Spree project directory:
| Command | Description |
|---|---|
spree dev | Run the app in the foreground — streams logs, Ctrl+C stops it. First run completes setup automatically; co-runs the React Dashboard dev server when apps/dashboard exists |
spree stop | Stop backend services |
spree update | Pull the latest Spree image and restart (runs migrations automatically) |
spree eject | Switch from the prebuilt image to building from backend/ |
spree add dashboard | Add the React Dashboard (Developer Preview) to an existing project |
spree build --production | Build the production image — the Spree API plus your dashboard, in one |
spree console / spree shell / spree logs | Rails console, container shell, log tailing |
spree migrate / spree seed / spree sample-data | Database tasks |
spree generate … | Spree generators (models, API resources, subscribers, migrations) |
spree user create / spree api-key … | Admin users and scoped API keys |
spree api get/post/patch/delete <path> | Call the Admin API directly (spree api endpoints lists routes + scopes) |
spree rspec | Run the backend test suite inside the container |
The full command reference lives on the docs site — this README intentionally stays short:
MIT