@spree/cli 3.4.1 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,19 +17,22 @@ Run from your Spree project directory:
|
|
|
17
17
|
|---------|-------------|
|
|
18
18
|
| `spree dev` | Run the app in the foreground — streams logs, Ctrl+C stops it. First run completes setup automatically; co-runs the Admin Dashboard dev server when `apps/dashboard` exists and opens the dashboard in the browser once it is ready (`--no-open` skips it) |
|
|
19
19
|
| `spree stop` | Stop backend services |
|
|
20
|
-
| `spree upgrade` | Upgrade Spree — the server
|
|
20
|
+
| `spree upgrade` | Upgrade Spree — the server, `@spree/*` packages, migrations and data backfills |
|
|
21
21
|
| `spree eject` | Switch from the prebuilt image to building from `backend/` |
|
|
22
22
|
| `spree add dashboard` | Add the Admin Dashboard to an existing project, to customize it |
|
|
23
23
|
| `spree add seller-dashboard` | Add the marketplace seller panel to an existing project |
|
|
24
|
+
| `spree add <extension>` | Install an extension end to end (e.g. `spree add stripe`) |
|
|
24
25
|
| `spree add ai` | Install the Spree agent skills and connect coding agents to the Spree docs MCP server |
|
|
25
26
|
| `spree build --production` | Build the production image — the Spree API plus your dashboard, in one |
|
|
26
|
-
| `spree console` / `spree shell` / `spree logs` |
|
|
27
|
+
| `spree console` / `spree shell` / `spree logs` | Backend console, container shell, log tailing |
|
|
27
28
|
| `spree migrate` / `spree seed` / `spree sample-data` | Database tasks |
|
|
28
29
|
| `spree generate …` | Spree generators (models, API resources, subscribers, migrations) |
|
|
30
|
+
| `spree task <name>` | Run a Spree maintenance task (e.g. `search:reindex`) |
|
|
29
31
|
| `spree user create` / `spree api-key …` | Admin users and scoped API keys |
|
|
30
|
-
| `spree encryption init` | Add
|
|
32
|
+
| `spree encryption init` | Add encryption keys to `.env` (`--print` to only print a set) |
|
|
31
33
|
| `spree api get/post/patch/delete <path>` | Call the Admin API directly (`spree api endpoints` lists routes + scopes) |
|
|
32
|
-
| `spree
|
|
34
|
+
| `spree test` | Run the backend test suite inside the container |
|
|
35
|
+
| `spree exec <command>` | Run any other command inside the container |
|
|
33
36
|
|
|
34
37
|
## Documentation
|
|
35
38
|
|