Shopware CLI is a command line companion for common Shopware account, project, and extension workflows.

• What it helps with
• Highlights
• Install
• Usage
• Repository Layout
• Documentation
• Contributing
• License

Use this CLI to create and set up Shopware projects, manage Shopware accounts, build and validate extensions, automate project maintenance, or run everyday developer tasks without leaving the terminal.

• Installation, initialization, and migration wizards for creating new Shopware projects or moving existing projects into the local development setup
• Integrated Docker-based local development environment with an interactive terminal user interface (TUI)
• Daily development loop support from one place: start environments, run watchers, check logs, access database and mail tools
• Project automation commands for config, cache, admin, storefront, and CI workflows
• Account-related commands under shopware-cli account
• Extension build, validation, formatting, changelog, and packaging helpers
• Non-interactive mode for scripts and CI

go install github.com/shopware/shopware-cli@latest

git clone https://github.com/shopware/shopware-cli.git
cd shopware-cli
go build -o bin/shopware-cli .

Show the available commands:

shopware-cli --help

Common command groups:

shopware-cli account --help
shopware-cli extension --help
shopware-cli project --help

Generate a CycloneDX SBOM for a project without running the full CI build:

shopware-cli project sbom
shopware-cli project sbom ./my-shop --format cyclonedx-json --output sbom.json

If you need CI-friendly behavior, disable prompts:

shopware-cli --no-interaction <command>

Silence update notifications for a single command:

shopware-cli --no-update-hint

Shop URL and Admin API credentials belong under named environments in .shopware-project.yml. Project-level keys such as build, dump, docker, and php_version stay at the top level.

environments:
  local:
    type: local
    url: http://127.0.0.1:8000
    admin_api:
      username: admin
      password: shopware
  staging:
    url: https://staging.example.com
    admin_api:
      client_id: ...
      client_secret: ...

Omit -e / --env to target environments.local. Use -e staging (or another name) to target a different environment.

shopware-cli project create and shopware-cli project config init write environments.local. Top-level url and admin_api are deprecated: existing files that still use them keep working until that support is removed, and mixed files (top-level shop plus environments.local) are not silently retargeted.

To disable update notifications for the current shell session, set:

export SHOPWARE_CLI_NO_UPDATE_NOTIFICATION=true

To make the setting persistent, add the export command to your shell profile, such as ~/.bashrc or ~/.zshrc.

• cmd/: Cobra command groups for account, extension, and project workflows
• internal/: implementation packages for APIs, build steps, validation, TUI, and utilities
• .github/: automation and workflow definitions
• scripts/: repository helper scripts
• env-bridge/: environment bridge helper entrypoint

Shopware CLI maintainers provide official Agent Skills in this repository's skills/ folder. These skills teach compatible AI coding agents how to use Shopware CLI workflows safely and correctly.

Install them with:

npx skills add shopware/shopware-cli

Available skills are shopware-cli and shopware-cli-docker.

• Official docs: https://developer.shopware.com/docs/products/cli/

Contributions are welcome. If you want to improve commands, docs, or developer workflows, open an issue or send a pull request.

See LICENSE.