README

A Castor plugin that turns a PHP description of your stack into a Sylius app, and gives you the tasks to drive it.

• Installation
• 🦫 Available commands
  • Add or Remove plugins
    • ✚ Add plugins
    • Available plugins
    • ❌ Remove plugins
    • Available plugins
  • 💳 Setup payment gateways
    • Available payment gateways
  • ☰ Remove menu items from the Admin panel
    • Available options
    • Default menu items
• E-commerce import
  • Prerequisites
  • AI Generated Catalog
    • Generate a catalog from a description
    • Generate the Sylius fixtures files
    • Load the fixture suite
  • Using data from an existing website
  • License

Installation

1. Create a castor.php file in your project root:

2. Create a composer file for Castor:

echo '{}' > castor.composer.json

1. Install the Castor plugin for Sylius

castor composer require castor-php/sylius "@dev"

1. Setup a new Sylius application

castor docker:service:install sylius

🦫 Available commands

Add or Remove plugins

Install or uninstall Sylius plugins with simple commands.

Note: Payment gateways are managed separately with sylius:payment-gateways:setup.

✚ Add plugins

A single command to add all the Sylius plugins you need.

Example:

castor sylius:add cms invoicing refund

Available plugins

❌ Remove plugins

A single command to remove the Sylius plugins you do not need anymore.

Example:

castor sylius:remove invoicing cms

Available plugins

💳 Setup payment gateways

Configure which payment gateways are active in your Sylius application.

Note: Payment gateways have their own dedicated command and are not managed through sylius:add / sylius:remove by design.

A single command to setup which payment gateways you want to use in your Sylius application. By default, only installs the selected gateways. Pass --only to also remove unselected gateways.

Example:

castor sylius:payment-gateways:setup stripe

You can also pass multiple gateways:

castor sylius:payment-gateways:setup paypal stripe

If no arguments are provided, an interactive prompt will ask you to choose the payment gateways.

Remove unselected gateways:

castor sylius:payment-gateways:setup --only stripe

Available payment gateways

☰ Remove menu items from the Admin panel

Clean up the Sylius Admin panel by removing menu items you don't need.

This command generates application/src/Menu/Admin/RemoveMenuItemsListener.php, a Symfony event listener that hides matching items from the admin main menu. Subsequent runs automatically merge new items into the existing list without prompting.

Pass one or more menu item names as arguments. Use parent/child syntax for sub-items.

Example:

castor sylius:menu:remove official_support sylius.ui.administration
castor sylius:menu:remove marketing/product_reviews

Available options

Replace the removed-items list:

castor sylius:menu:remove customers orders --replace

Restore previously removed items:

castor sylius:menu:remove --restore customers
castor sylius:menu:remove -b customers orders

Example workflow:

# Hide customers and orders from the admin menu
castor sylius:menu:remove customers orders

# Later, hide product reviews too (auto-merged)
castor sylius:menu:remove marketing/product_reviews

# Restore the customers menu item
castor sylius:menu:remove -b customers

Default menu items

Top-level items:

Sub-items (use parent/child syntax):

The package autoloads via Composer. Do not import('composer://castor-php/sylius') — that would load the package's local castor.php and conflict with your own context. Register SyliusService as shown above to expose all tasks ( sylius:*, app:*, sylius:import:*).

E-commerce import

Import products, collections, images and prices from an AI-generated catalog, or load YAML produced by an external fetch step into Sylius fixtures.

Prerequisites

1. Make sure you have already set up your Sylius application using the castor docker:service:install sylius command.

2. Configure AI in .castor/.env (created automatically when you run the first import command). You can copy the default values from .castor/.env.example.

You can also create a .castor/.env.local file for your sensitive values or local overrides.

AI Generated Catalog

Generate a catalog from a description

Generate a complete product catalog from a natural-language description using AI. The generated catalog is saved as YAML and can then be used to generate Sylius fixtures.

castor sylius:import:ai:build \
    --name="Organic Kids" \
    --description="An online store selling organic clothes for children"

This will generate a catalog for Organic Kids, including products and collections, based on the provided description. Import data is stored per project slug under .castor/import/var/{project-slug}/.

Generate the Sylius fixtures files

castor sylius:import:fixtures:generate ai --project="Organic Kids" --limit=100

Load the fixture suite

castor sylius:import:fixtures:load --project="Organic Kids"

Using data from an existing website

It requires a YAML import under .castor/import/var/{project-slug}/ (products + collections). If you use the private castor-php/sylius-import-fetch plugin, run sylius:import:existing:fetch first; otherwise prepare the YAML yourself.

castor sylius:import:fixtures:generate existing --project=example --limit=100
castor sylius:import:fixtures:load --project=example

License

This plugin is part of the Castor project, released under the MIT license.