Provides comprehensive guidance for Saleor Configurator CLI commands and usage patterns. This skill should be invoked when the user asks about deploying configurations, introspecting stores, running diffs, or executing any CLI operations against a Saleor instance. Covers deploy, introspect, diff, and start commands with all flags and environment variables.
View on GitHubFebruary 3, 2026
Select agents to install to:
npx add-skill https://github.com/saleor/configurator/blob/main/plugin/skills/configurator-cli/SKILL.md -a claude-code --skill configurator-cliInstallation paths:
.claude/skills/configurator-cli/# Configurator CLI The Saleor Configurator CLI is a declarative "commerce as code" tool that syncs YAML configuration files with Saleor e-commerce instances. ## Core Commands ### introspect Fetches the current configuration from a Saleor instance and writes it to `config.yml`. ```bash npx configurator introspect --url=$SALEOR_API_URL --token=$SALEOR_TOKEN ``` **Use cases:** - Initial setup: Pull existing store configuration - Backup: Snapshot current state before changes - Recovery: Restore from known-good state ### deploy Pushes local `config.yml` changes to a Saleor instance. ```bash npx configurator deploy --url=$SALEOR_API_URL --token=$SALEOR_TOKEN ``` **Important flags:** - `--dry-run`: Preview changes without applying - `--fail-on-delete`: Abort if any deletions would occur - `--include <types>`: Only deploy specific entity types - `--exclude <types>`: Skip specific entity types - `--skip-media`: Skip media file uploads **Safety notes:** - Always run `diff` before `deploy` to preview changes - Use `--fail-on-delete` in CI/CD pipelines - Back up with `introspect` before major changes ### diff Compares local `config.yml` with remote Saleor instance. ```bash npx configurator diff --url=$SALEOR_API_URL --token=$SALEOR_TOKEN ``` **Output shows:** - `+ CREATE`: New entities to be created - `~ UPDATE`: Entities with modifications - `- DELETE`: Entities that will be removed ### start Interactive setup wizard for new configurations. ```bash npx configurator start ``` ## Common Flags | Flag | Commands | Description | |------|----------|-------------| | `--url` | All | Saleor GraphQL endpoint URL | | `--token` | All | Saleor API authentication token | | `--include` | deploy, diff | Comma-separated entity types to include | | `--exclude` | deploy, diff | Comma-separated entity types to exclude | | `--fail-on-delete` | deploy | Exit with error if deletions detected | | `--dry-run` | deploy | Show plan without executing changes | | `--skip-media` | deplo