mcpField
S
saleor-configurator

saleor-configurator

github.com/saleorDevelopment2404 installsUpdated 12w ago
Repository

About saleor-configurator

Saleor Configurator is a skill guide for defining a Saleor store’s configuration in YAML and deploying it declaratively with its CLI. It covers schema, entity identity, deployment, diffs, and environment migration.

Key features

  1. 01Guide YAML configuration authoring
  2. 02Explain entity identity strategies
  3. 03Document CLI commands and options
  4. 04Describe deployment order and failure handling
  5. 05Explain diff and synchronization behavior

Use cases

  1. 01Write or edit a store's `config.yml`
  2. 02Diagnose differences from remote state
  3. 03Set up automated deployment pipelines
  4. 04Move configuration between environments

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/saleor/agent-skills --skill saleor-configurator

After installing, type/saleor-configuratorin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

AGENTS.md
README.md
rules/
cli-commands.md
config-schema.md
deploy-pipeline.md
diff-behavior.md
identity-strategies.md

Details

From the project README

Saleor Configurator

Guide for using Saleor Configurator — a "commerce as code" CLI that lets you define your entire Saleor store configuration in YAML and deploy it declaratively.

When to Apply

  • Writing or editing config.yml for a Saleor store
  • Running deploy, introspect, or diff commands
  • Understanding which identifier to use (slug vs name) for each entity
  • Debugging mismatches between local config and remote state
  • Setting up CI/CD pipelines for automated deployments
  • Migrating store configuration between environments

Rule Categories by Priority

PriorityCategoryImpactPrefix
1Config SchemaCRITICALconfig-
2Entity IdentityCRITICALidentity-
3CLI WorkflowHIGHcli-
4DeploymentHIGHdeploy-
5Diff & SyncMEDIUMdiff-

Quick Reference

1. Config Schema (CRITICAL)
  • config-schema — YAML structure, all top-level keys, entity examples
2. Entity Identity (CRITICAL)
  • identity-strategies — Slug-based vs name-based vs singleton; which entity uses which
3. CLI Workflow (HIGH)
  • cli-commands — All commands, flags, env vars, credential setup, non-interactive mode
4. Deployment (HIGH)
  • deploy-pipeline — Stage order, dependency graph, selective deployment, failure handling
5. Diff & Sync (MEDIUM)
  • diff-behavior — How diff detects changes, what triggers create/update/delete

How to Use

Read individual rule files for detailed explanations and examples:

rules/config-schema.md
rules/identity-strategies.md
rules/cli-commands.md
rules/deploy-pipeline.md
rules/diff-behavior.md

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

Comments

Markdown supported