shopware-cli
Shopware CLI is a command line companion for common Shopware account, project, and extension workflows.
Automatically checked · GitHub checked 2026-11-13

Before you switch
Evaluate hosting, migration and feature requirements before switching.
Overview
Shopware CLI
Shopware CLI is a command line companion for common Shopware account, project, and extension workflows.
Table of Contents
- What it helps with
- Highlights
- Install
- Usage
- Repository Layout
- Official Agent Skills
- Documentation
- Contributing
- License
What it helps with
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.
Highlights
- 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
Install
From source with Go
go install github.com/shopware/shopware-cli@latest
Build locally from this repository
git clone https://github.com/shopware/shopware-cli.git
cd shopware-cli
go build -o ./bin/shopware-cli .
Usage
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
Configuration
Shop URL and Admin API credentials belong under named environments in
.config/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: they are
used only when environments.local is absent. When both are present,
environments.local wins.
Disable update notifications
To disable update notifications for the current shell session, set:
export SHOPWARE_CLI_NO_UPDATE_NOTIFICATION=true
To make the setting persistent, set no_update_hint: true in the user
config file (see below), or add the export command to your shell profile, such
as ~/.bashrc or ~/.zshrc. Pass --no-update-hint to skip the check for a
single command. --no-interaction (-n) also skips it, but additionally
disables prompts, so commands use defaults or fail where input is needed.
User config file
Shopware CLI reads optional user preferences from config.yaml in a
shopware-cli folder inside your user config directory:
- Linux:
$XDG_CONFIG_HOME/shopware-cli/config.yaml(default~/.config/shopware-cli/config.yaml) - macOS:
~/Library/Application Support/shopware-cli/config.yaml - Windows:
%AppData%\shopware-cli\config.yaml
Set SHOPWARE_CLI_CONFIG to use a different path. The CLI never creates or
writes this file. Without it, telemetry and update hints are enabled.
telemetry: false # disable anonymous usage telemetry
no_update_hint: true # disable update notifications
Command-line flags and environment variables take precedence over the file:
--no-update-hint (or -n) > SHOPWARE_CLI_NO_UPDATE_NOTIFICATION >
no_update_hint, and DO_NOT_TRACK > telemetry. See
docs/TELEMETRY.md for what telemetry collects.
Repository Layout
cmd/: Cobra command groups for account, extension, and project workflowsinternal/: implementation packages for APIs, build steps, validation, TUI, and utilities.github/: automation and workflow definitionsscripts/: repository helper scriptsenv-bridge/: environment bridge helper entrypoint
Official Agent Skills
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:
shopware-cli— Use Shopware CLI for project, extension, and account workflows. Validate, build, format, and troubleshoot extensions. Reason about command safety and side effects.shopware-cli-docker— For Docker-backed projects. Run commands in the correct container, manage development environment lifecycle, and troubleshoot Docker execution.shopware-cli-extension-store— Assess an extension's readiness for Shopware Store distribution. Read-only: classifies metadata, localization, and asset findings against Store requirements and cites a re-checkable source for each, without modifying files.shopware-cli-extension-anonymize— Fill an extension'sanonymizesection in.config/shopware-extension.ymlfrom its tables and system config secrets soproject dump --anonymizeincludes them.
Documentation
- Official docs: https://developer.shopware.com/docs/products/cli/
Contributing
Contributions are welcome. If you want to improve commands, docs, or developer workflows, open an issue or send a pull request. See CONTRIBUTING.md.
License
See LICENSE.