@spree/docs 0.1.90 → 0.1.91

package/dist/developer/admin/admin.md

@@ -159,7 +159,16 @@ The Admin Dashboard uses [Tailwind CSS v4](https://tailwindcss.com/) for styling
 
 ### Generator Commands
 
-```bash
+
+```bash Spree CLI (Docker)
+# Generate a complete admin section (controller, views, routes)
+spree generate spree:admin:scaffold Spree::Brand
+
+# Generate just a controller
+spree generate controller Spree::Admin::Brands --skip-routes
+```
+
+```bash Without Spree CLI
 # Generate a complete admin section (controller, views, routes)
 bin/rails g spree:admin:scaffold Spree::Brand
 
@@ -167,6 +176,7 @@ bin/rails g spree:admin:scaffold Spree::Brand
 bin/rails g controller Spree::Admin::Brands --skip-routes
 ```
 
+
 ## Authentication & Authorization
 
 ### Authentication

package/dist/developer/admin/custom-css.md

@@ -147,16 +147,28 @@ If you have admin-related code in non-standard locations, add additional `@sourc
 
 During development, run the Tailwind CSS watcher to automatically rebuild styles when you make changes:
 
-```bash
-bin/rails spree:admin:tailwindcss:watch
+
+```bash Spree CLI (Docker)
+spree rake spree:admin:tailwindcss:watch
 ```
 
-Or if you're using `Procfile.dev` with foreman:
+```bash Without Spree CLI
+bundle exec rake spree:admin:tailwindcss:watch
+```
 
-```bash
+
+Or run the full development process, which includes the watcher when it's defined in `Procfile.dev`:
+
+
+```bash Spree CLI (Docker)
+spree dev
+```
+
+```bash Without Spree CLI
 bin/dev
 ```
 
+
 The watcher monitors:
 - Your host app's CSS files in `app/assets/tailwind/`
 - The Spree Admin engine's CSS files

package/dist/developer/core-concepts/pricing.md

@@ -220,18 +220,30 @@ end
 
 Price history retention defaults to 30 days and can be configured globally. A Rake task is provided for cleanup:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree rake spree:price_history:prune
+```
+
+```bash Without Spree CLI
 bundle exec rake spree:price_history:prune
 ```
 
+
 ### Seeding Existing Prices
 
 After enabling price history on an existing store, seed the current prices as a baseline:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree rake spree:price_history:seed
+```
+
+```bash Without Spree CLI
 bundle exec rake spree:price_history:seed
 ```
 
+
 ## Related Documentation
 
 - [Products](products.md) — Products, Variants, and base prices

package/dist/developer/core-concepts/translations.md

@@ -104,10 +104,16 @@ Spree stores UI translation strings in a separate project: [Spree I18n](https://
 
 To install UI translations:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree bundle add spree_i18n
+```
+
+```bash Without Spree CLI
 bundle add spree_i18n
 ```
 
+
 Once installed, all translation files are available automatically — no need to copy any files.
 
 > **INFO:** The full list of supported locales is available in the [Spree I18n GitHub repository](https://github.com/spree-contrib/spree_i18n/tree/main/config/locales).

package/dist/developer/customization/authentication.md

@@ -20,10 +20,16 @@ Spree.user_class = 'User'
 
 Now, run the generator to set up Spree integration with Devise:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate spree:authentication:devise
+```
+
+```bash Without Spree CLI
 bin/rails g spree:authentication:devise
 ```
 
+
 This will create a new file in `lib/spree/authentication_helpers.rb` that serves as a bridge between Spree and your existing authentication system routes. You can then use this file to customize the routes to your liking. It should automatically pick up standard Devise routes.
 
 Secondly, this generator will add necessary modules to your `User` model.
@@ -64,10 +70,16 @@ Spree.user_class = 'User'
 
 Now, run the generator to set up Spree integration with your custom authentication system:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate spree:authentication:custom
+```
+
+```bash Without Spree CLI
 bin/rails g spree:authentication:custom
 ```
 
+
 This will create a new file in `lib/spree/authentication_helpers.rb` that serves as a bridge between Spree and your existing authentication system routes. You will need to customize this file to fit your needs.
 
 Secondly, this generator will add necessary modules to your `User` model.

package/dist/developer/customization/decorators.md

@@ -86,10 +86,16 @@ Spree provides generators to create decorator files with the correct structure:
 
 ### Model Decorator Generator
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate spree:model_decorator Spree::Product
+```
+
+```bash Without Spree CLI
 bin/rails g spree:model_decorator Spree::Product
 ```
 
+
 This creates `app/models/spree/product_decorator.rb`:
 
 ```ruby
@@ -106,10 +112,16 @@ end
 
 ### Controller Decorator Generator
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate spree:controller_decorator Spree::Admin::ProductsController
+```
+
+```bash Without Spree CLI
 bin/rails g spree:controller_decorator Spree::Admin::ProductsController
 ```
 
+
 This creates `app/controllers/spree/admin/products_controller_decorator.rb`:
 
 ```ruby

package/dist/developer/customization/emails.md

@@ -12,10 +12,16 @@ Spree uses [postmark templates](https://github.com/wildbit/postmark-templates),
 
 Spree offers an emails preview generator for development purposes. To generate them, use the command:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate spree:emails:install
+```
+
+```bash Without Spree CLI
 bin/rails g spree:emails:install
 ```
 
+
 After that, start the rails server locally and go to: `localhost:3000/rails/mailers`
 
 (it requires a seeded development database in order to work properly)

package/dist/developer/customization/model-preferences.md

@@ -15,16 +15,28 @@ To define a model preference, you need to add them to your model class.
 
 Make sure to generate a migration to add the `preferences` column to the table. This column will store the preferences in a serialized format.
 
-```ruby
-rails g migration AddPreferencesToSpreeUsers preferences:text
+
+```bash Spree CLI (Docker)
+spree generate migration AddPreferencesToSpreeUsers preferences:text
 ```
 
+```bash Without Spree CLI
+bin/rails g migration AddPreferencesToSpreeUsers preferences:text
+```
+
+
 Run the migration.
 
-```ruby
-rails db:migrate
+
+```bash Spree CLI (Docker)
+spree migrate
 ```
 
+```bash Without Spree CLI
+bin/rails db:migrate
+```
+
+
 ```ruby
 class Spree::User < ApplicationRecord
   # ... you existing code ...

package/dist/developer/deployment/caching.md

@@ -19,9 +19,14 @@ When `REDIS_URL` is set, Spree automatically uses it for caching. When not set,
 
 To enable caching in the development environment:
 
-```bash
-cd server
+
+```bash Spree CLI (Docker)
+spree rails dev:cache
+```
+
+```bash Without Spree CLI
 bin/rails dev:cache
 ```
 
+
 You will need to restart your web server after this.

package/dist/developer/deployment/environment_variables.md

@@ -84,10 +84,16 @@ After setting these, enable the provider and reindex:
 Spree.search_provider = 'Spree::SearchProvider::Meilisearch'
 ```
 
-```bash
-rake spree:search:reindex
+
+```bash Spree CLI (Docker)
+spree rake spree:search:reindex
+```
+
+```bash Without Spree CLI
+bundle exec rake spree:search:reindex
 ```
 
+
 ## Error Tracking (Sentry)
 
 | Variable | Default | Description |

package/dist/developer/multi-store/quickstart.md

@@ -5,10 +5,16 @@ sidebarTitle: Quickstart
 
 To enable multiple stores, you will need to add the `spree_multi_store` gem to your project via:
 
-```bash
+
+```bash Spree CLI (Docker)
+spree bundle add spree_multi_store
+```
+
+```bash Without Spree CLI
 bundle add spree_multi_store
 ```
 
+
 > **INFO:** Spree Multi-Store is licensed under the [AGPL v3 License](https://opensource.org/licenses/AGPL-3.0). 
 > 
 > If you would like to use it in a commercial application, please [contact us](https://spreecommerce.org/get-started/) to obtain a commercial license.

package/dist/developer/multi-tenant/core-concepts.md

@@ -17,10 +17,16 @@ All models that are tenanted inherit from `SpreeMultiTenant::Base` class. `spree
 
 When creating a new model that you want to be tenanted remember to inherit from `SpreeMultiTenant::Base` and not from `Spree::Base` and add `tenant_id` column to the table, eg.
 
-```bash
+
+```bash Spree CLI (Docker)
+spree generate model Spree::NewModel tenant:references name:string --parent SpreeMultiTenant::Base
+```
+
+```bash Without Spree CLI
 bin/rails g model Spree::NewModel tenant:references name:string --parent SpreeMultiTenant::Base
 ```
 
+
 > **INFO:** You don't need to add `belongs_to :tenant` to the model, it's handled by gem.
 
 ## Tenant selector

package/dist/developer/multi-tenant/installation.md

@@ -37,10 +37,16 @@ Admin user classes will be shared across tenants allowing them to manage multipl
 
 Let's create a new model with Devise (unless you already have one):
 
-```bash
-rails g devise Spree::AdminUser
+
+```bash Spree CLI (Docker)
+spree rails g devise Spree::AdminUser
+```
+
+```bash Without Spree CLI
+bin/rails g devise Spree::AdminUser
 ```
 
+
 Replace the generated Devise code with the following:
 
 ```ruby
@@ -83,14 +89,30 @@ Spree.admin_user_class = "Spree::AdminUser"
 
 2. Install gems:
 
-    ```bash
+    
+
+    ```bash Spree CLI (Docker)
+    spree bundle install
+    ```
+
+    ```bash Without Spree CLI
     bundle install
     ```
 
+    
+
 3. Run generators:
 
-    ```bash
-    bundle exec rails g spree_enterprise:install && bundle exec rails g spree_multi_tenant:install
+    
+
+    ```bash Spree CLI (Docker)
+    spree generate spree_enterprise:install && spree generate spree_multi_tenant:install
     ```
 
+    ```bash Without Spree CLI
+    bin/rails g spree_enterprise:install && bin/rails g spree_multi_tenant:install
+    ```
+
+    
+
     > **INFO:** This will copy and run migrations for `spree_enterprise` and `spree_multi_tenant` gems.

package/dist/developer/multi-vendor/installation.md

@@ -32,14 +32,30 @@ description: Learn how to set up a multi-vendor marketplace with Spree
 
 2. Install gems:
 
-    ```bash
+    
+
+    ```bash Spree CLI (Docker)
+    spree bundle install
+    ```
+
+    ```bash Without Spree CLI
     bundle install
     ```
 
+    
+
 3. Run generators:
 
-    ```bash
-    bundle exec rails g spree_enterprise:install && bundle exec rails g spree_multi_vendor:install
+    
+
+    ```bash Spree CLI (Docker)
+    spree generate spree_enterprise:install && spree generate spree_multi_vendor:install
+    ```
+
+    ```bash Without Spree CLI
+    bin/rails g spree_enterprise:install && bin/rails g spree_multi_vendor:install
     ```
 
+    
+
     > **INFO:** This will copy and run migrations for `spree_enterprise` and `spree_multi_vendor` gems.

package/dist/developer/upgrades/5.4-to-5.5.md

@@ -17,15 +17,15 @@ The upgrade is usually completed in five steps:
 For applications created via `create-spree-app` command we greatly recommend using the Spree CLI to perform the upgrade. It provides a guided experience with prompts and handles the first three steps for you. If you prefer to run the commands manually or not using docker for local development, you can follow the "Without Spree CLI" path.
 
 
-```bash Spree CLI
+```bash Spree CLI (Docker)
 spree upgrade
 ```
 
 ```bash Without Spree CLI
 # cd backend if you're in the monorepo root
 bundle update
-bin/rake spree:install:migrations && bin/rails db:migrate
-bin/rake spree:upgrade
+bundle exec rake spree:install:migrations && bin/rails db:migrate
+bundle exec rake spree:upgrade
 ```
 
 
@@ -39,30 +39,42 @@ npm install -g @spree/cli
 npx @spree/cli upgrade
 ```
 
-The **Without Spree CLI** path is the bare equivalent. Use this on production: `bundle update` and `db:migrate` are part of your existing deploy pipeline (Heroku release phase, K8s init container, Capistrano hook, Render auto-migrate). Once the 5.5 release is up, run `bin/rake spree:upgrade` from a one-off dyno / job container / `kubectl exec` to perform the data backfills.
+The **Without Spree CLI** path is the bare equivalent. Use this on production: `bundle update` and `db:migrate` are part of your existing deploy pipeline (Heroku release phase, K8s init container, Capistrano hook, Render auto-migrate). Once the 5.5 release is up, run `bundle exec rake spree:upgrade` from a one-off dyno / job container / `kubectl exec` to perform the data backfills.
 
-Skipping versions and re-running are both safe — `bin/rake spree:upgrade` figures out what still needs to happen and does nothing on data that's already migrated.
+Skipping versions and re-running are both safe — `bundle exec rake spree:upgrade` figures out what still needs to happen and does nothing on data that's already migrated.
 
 ## What the upgrade does
 
-This is reference material — what `bin/rake spree:upgrade` (and equivalently `spree upgrade`) actually executes on your data. Skip if you trust the tool; read on if something failed or you're curious.
+This is reference material — what `bundle exec rake spree:upgrade` (and equivalently `spree upgrade`) actually executes on your data. Skip if you trust the tool; read on if something failed or you're curious.
 
 ### Migrate legacy variant-pinned media
 
 In 5.5 the [product is the default owner of media](../core-concepts/media.md#product-level-gallery). Existing variant-pinned images keep rendering, but new admin uploads attach to the product. To consolidate both into a single gallery, the upgrade runs:
 
-```bash
-bin/rails spree:media:migrate_master_images_to_product_media
+
+```bash Spree CLI (Docker)
+spree rake spree:media:migrate_master_images_to_product_media
+```
+
+```bash Without Spree CLI
+bundle exec rake spree:media:migrate_master_images_to_product_media
 ```
 
+
 The task enqueues one `Spree::Media::MigrateProductAssetsJob` per product onto the `images` queue — make sure your job runner is processing that queue. Each job is idempotent, so re-running the task is safe; it skips products that no longer have variant-pinned assets.
 
 For larger catalogs, tune the batching with `BATCH_SIZE`:
 
-```bash
-bin/rails spree:media:migrate_master_images_to_product_media BATCH_SIZE=1000
+
+```bash Spree CLI (Docker)
+spree rake spree:media:migrate_master_images_to_product_media BATCH_SIZE=1000
+```
+
+```bash Without Spree CLI
+bundle exec rake spree:media:migrate_master_images_to_product_media BATCH_SIZE=1000
 ```
 
+
 > **WARNING:** Run the task locally and on production. It does not block storefront rendering — new uploads attach to the product immediately — but until the enqueued jobs finish, old assets remain pinned to variants.
 
 ### Run the Channels upgrade
@@ -71,10 +83,16 @@ Spree 5.5 introduces [Sales Channels](../core-concepts/channels.md) — a per-st
 
 The migrations add a `default` boolean on `spree_channels`, a `store_id` column on `spree_products`, and create the new `spree_product_publications` table — **but they do not seed default channels, attach existing products to a store, or backfill order channels**. That work is done by an idempotent rake task:
 
-```bash
-bin/rake spree:channels:upgrade
+
+```bash Spree CLI (Docker)
+spree rake spree:channels:upgrade
+```
+
+```bash Without Spree CLI
+bundle exec rake spree:channels:upgrade
 ```
 
+
 The task runs four sub-tasks in order:
 
 1. `spree:channels:create_defaults` — creates the default "Online Store" channel for every existing store (via `Store#ensure_default_channel`).
@@ -90,10 +108,16 @@ The task is fully idempotent — safe to re-run if it fails partway, and a no-op
 
 The last step rebuilds the search index against the configured [search provider](../core-concepts/search-filtering.md):
 
-```bash
-bin/rake spree:search:reindex
+
+```bash Spree CLI (Docker)
+spree rake spree:search:reindex
+```
+
+```bash Without Spree CLI
+bundle exec rake spree:search:reindex
 ```
 
+
 This is a no-op on the default Database provider (there is no external index to maintain). For Meilisearch — or any other external search provider — it is required, and it must run **after** the Channels upgrade: products only become visible to `Product.for_store` once they have a `store_id`, so reindexing before the channels step would index zero products. The manifest orders the steps accordingly.
 
 #### Multi-store catalogs
@@ -132,7 +156,7 @@ The SDK bump pairs with one storefront code change in this release: the [payment
 
 ## Required post-upgrade configuration
 
-`bin/rake spree:upgrade` doesn't touch your job-runner config — every app uses a different scheduler, so this one is on you.
+`bundle exec rake spree:upgrade` doesn't touch your job-runner config — every app uses a different scheduler, so this one is on you.
 
 ### Schedule the Stock Reservations expiry job
 

package/dist/integrations/analytics/google-analytics.md

@@ -14,10 +14,16 @@ With minimal setup required, you can gain valuable insights into how visitors in
 
 Before you can enable Google Analytics 4, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_google_analytics && bundle exec rails g spree_google_analytics:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_google_analytics && spree generate spree_google_analytics:install
+```
+
+```bash Without Spree CLI
+bundle add spree_google_analytics && bin/rails g spree_google_analytics:install
 ```
 
+
 After that, make sure to restart your server if it was running.
 
 ## Connect Google Analytics

package/dist/integrations/analytics/google-tag-manager.md

@@ -24,10 +24,16 @@ Spree will automatically push ecommerce events to the dataLayer, but it’s up t
 
 Before you can enable Google Tag Manager, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_google_analytics && bundle exec rails g spree_google_analytics:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_google_analytics && spree generate spree_google_analytics:install
+```
+
+```bash Without Spree CLI
+bundle add spree_google_analytics && bin/rails g spree_google_analytics:install
 ```
 
+
 After that, make sure to restart your server if it was running.
 
 ## Connect Google Tag Manager

package/dist/integrations/marketing/klaviyo.md

@@ -14,10 +14,16 @@ With Spree’s native integration, you can start collecting meaningful data for
 
 To install the Klaviyo integration, you need to run the following command:
 
-```bash
-bundle add spree_klaviyo && bundle exec rails g spree_klaviyo:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_klaviyo && spree generate spree_klaviyo:install
+```
+
+```bash Without Spree CLI
+bundle add spree_klaviyo && bin/rails g spree_klaviyo:install
 ```
 
+
 After that, you need to make sure to restart the server.
 
 ## Connect Klaviyo

package/dist/integrations/payments/adyen.md

@@ -10,10 +10,16 @@ Adyen is a global payment platform that enables businesses to accept payments ac
 
 Before you can enable Adyen, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_adyen --github spree/spree_adyen && bundle exec rails g spree_adyen:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_adyen --github spree/spree_adyen && spree generate spree_adyen:install
+```
+
+```bash Without Spree CLI
+bundle add spree_adyen --github spree/spree_adyen && bin/rails g spree_adyen:install
 ```
 
+
 After that, you need to make sure to restart the server.
 
 ## Connect Adyen

package/dist/integrations/payments/paypal.md

@@ -10,10 +10,16 @@ PayPal is a global online payment system that allows your customers to pay using
 
 Before you can enable PayPal, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_paypal_checkout && bundle exec rails g spree_paypal_checkout:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_paypal_checkout && spree generate spree_paypal_checkout:install
+```
+
+```bash Without Spree CLI
+bundle add spree_paypal_checkout && bin/rails g spree_paypal_checkout:install
 ```
 
+
 After that, you need to make sure to restart the server.
 
 ## Connect PayPal

package/dist/integrations/payments/razorpay.md

@@ -12,12 +12,18 @@ Razorpay is a secure payment gateway that enables businesses to accept online pa
 
 ## Installation
 
-Before you can enable Razorpay, it must be installed. To do so, you need to add this line in Gemfile:
+Before you can enable Razorpay, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_razorpay_checkout && bundle exec rails g spree_razorpay_checkout:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_razorpay_checkout && spree generate spree_razorpay_checkout:install
+```
+
+```bash Without Spree CLI
+bundle add spree_razorpay_checkout && bin/rails g spree_razorpay_checkout:install
 ```
 
+
 After that, you need to make sure to restart the server.
 
 ## Connect Razorpay

package/dist/integrations/payments/stripe.md

@@ -12,10 +12,16 @@ Stripe is a widely used payment processor that enables secure and seamless trans
 
 Before you can enable Stripe, it must be installed. To do so, you need to run the following command:
 
-```bash
-bundle add spree_stripe && bundle exec rails g spree_stripe:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_stripe && spree generate spree_stripe:install
+```
+
+```bash Without Spree CLI
+bundle add spree_stripe && bin/rails g spree_stripe:install
 ```
 
+
 After that, you need to make sure to restart the server.
 
 ## Connect Stripe

package/dist/integrations/search/meilisearch.md

@@ -51,10 +51,16 @@ docker run -d --name meilisearch \
 gem 'meilisearch', '>= 0.28'
 ```
 
-```bash
+
+```bash Spree CLI (Docker)
+spree bundle install
+```
+
+```bash Without Spree CLI
 bundle install
 ```
 
+
 ### 3. Configure environment variables
 
 ```bash
@@ -76,10 +82,16 @@ Spree.search_provider = 'Spree::SearchProvider::Meilisearch'
 
 ### 5. Index your products
 
-```bash
-rake spree:search:reindex
+
+```bash Spree CLI (Docker)
+spree rake spree:search:reindex
 ```
 
+```bash Without Spree CLI
+bundle exec rake spree:search:reindex
+```
+
+
 That's it. Your Store API now uses Meilisearch for all product search, filtering, and faceted navigation.
 
 ## How It Works
@@ -138,10 +150,16 @@ Each store gets its own Meilisearch index: `{store_code}_products`. For a store
 
 ### Reindex all products
 
-```bash
-rake spree:search:reindex
+
+```bash Spree CLI (Docker)
+spree rake spree:search:reindex
 ```
 
+```bash Without Spree CLI
+bundle exec rake spree:search:reindex
+```
+
+
 ### Index a single product
 
 ```ruby

package/dist/integrations/tax/avalara.md

@@ -12,10 +12,16 @@ Avalara AvaTax is an automated tax compliance platform that calculates accurate
 
 Before you can enable Avalara AvaTax, it must be installed. To do so, run the following command:
 
-```bash
-bundle add spree_avatax_official && bundle exec rails g spree_avatax_official:install
+
+```bash Spree CLI (Docker)
+spree bundle add spree_avatax_official && spree generate spree_avatax_official:install
+```
+
+```bash Without Spree CLI
+bundle add spree_avatax_official && bin/rails g spree_avatax_official:install
 ```
 
+
 After that, make sure to restart the server.
 
 ## Connect Avalara

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spree/docs",
-  "version": "0.1.90",
+  "version": "0.1.91",
   "description": "Spree Commerce developer documentation for AI agents and local reference",
   "type": "module",
   "license": "CC-BY-4.0",