Saleor Configurator

[!WARNING] This project is in early development. Please use with caution.

Saleor Configurator is a "commerce as code" tool that helps you automate the creation and management of data models in Saleor. Instead of manually creating product types, attributes, products, and variants, you can define them in a configuration file and let the tool handle the synchronization with your Saleor instance.

Usage

Prerequisites:

• Node.js 20+

Usage:

# Run directly (recommended)
pnpm dlx @saleor/configurator start
npx @saleor/configurator@latest start

# Or install globally
pnpm add -g @saleor/configurator
npm install -g @saleor/configurator
saleor-configurator start

Quickstart:

1. Create an app token with all permissions in your Saleor dashboard.

[!TIP] Use the start command to explore features interactively and see what's possible.

1. Introspect your current configuration from your remote Saleor instance:

pnpm dlx @saleor/configurator introspect --url https://your-store.saleor.cloud/graphql/ --token your-app-token

1. Modify the configuration to define your commerce setup. You can configure:
   • Store settings (shop configuration, channels, tax classes)
   • Product catalog (product types, categories, collections, products)
   • Fulfillment (warehouses, shipping zones and methods)
   • Content management (page types, models, menus)

[!NOTE] Key Resources for Configuration:

🔧 example.yml - Comprehensive working example with all entity types

📖 SCHEMA.md - Complete field documentation and validation rules

💡 Best Practices:

• Start with introspection to understand your current setup
• Make incremental changes and test with diff before deploying
• Configuration is treated as source of truth - undefined entities will be removed
• Always backup your data before major changes

1. Preview changes before applying:

pnpm dlx @saleor/configurator diff --url https://your-store.saleor.cloud/graphql/ --token your-app-token

1. Deploy your configuration:

pnpm dlx @saleor/configurator deploy --url https://your-store.saleor.cloud/graphql/ --token your-app-token

[!TIP] Use --help with any command to see all available options and examples.

Commands

All commands support the --help flag to display detailed usage information with examples.

start

Starts the interactive setup wizard that will guide you through the available operations.

pnpm dlx @saleor/configurator start

deploy

Deploys the local configuration to the remote Saleor instance with mandatory diff preview and safety confirmations.

# Basic usage with diff preview and confirmation
pnpm dlx @saleor/configurator deploy --url https://your-store.saleor.cloud/graphql/ --token your-app-token

# With custom config file
pnpm dlx @saleor/configurator deploy --url https://your-store.saleor.cloud/graphql/ --token your-app-token --config production.yml

# CI mode (skip all confirmations for automated environments)
pnpm dlx @saleor/configurator deploy --url https://your-store.saleor.cloud/graphql/ --token your-app-token --ci

# Show help
pnpm dlx @saleor/configurator deploy --help

Arguments:

• --url (required): Saleor instance URL
• --token (required): Saleor API token
• --config (optional): Configuration file path (default: config.yml)
• --ci (optional): CI mode - skip all confirmations for automated environments
• --quiet (optional): Suppress output
• --help: Show command help with examples

diff

Shows the differences between the local and remote Saleor instances.

# Basic usage
pnpm dlx @saleor/configurator diff --url https://your-store.saleor.cloud/graphql/ --token your-app-token

# With custom config file
pnpm dlx @saleor/configurator diff --url https://your-store.saleor.cloud/graphql/ --token your-app-token --config production.yml

# Show help
pnpm dlx @saleor/configurator diff --help

Arguments:

• --url (required): Saleor instance URL
• --token (required): Saleor API token
• --config (optional): Configuration file path (default: config.yml)
• --quiet (optional): Suppress output
• --help: Show command help with examples

introspect

Shows the current state of the remote Saleor instance and upon confirmation saves it to a configuration file.

# Basic usage (shows diff and asks for confirmation)
pnpm dlx @saleor/configurator introspect --url https://your-store.saleor.cloud/graphql/ --token your-app-token

# With custom config file
pnpm dlx @saleor/configurator introspect --url https://your-store.saleor.cloud/graphql/ --token your-app-token --config production.yml

# Show help
pnpm dlx @saleor/configurator introspect --help

Arguments:

• --url (required): Saleor instance URL
• --token (required): Saleor API token
• --config (optional): Configuration file path (defa

...