Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ redirects:
guides/plugins/plugins/administration/adding-responsive-behavior.html: guides/plugins/plugins/administration/ui-ux/adding-responsive-behavior.html
products/plugins/commercial/: products/extensions/commercial/
guides/installation/devenv.html: guides/installation/setups/devenv.html
products/cli/extension-commands/validation.html: products/cli/validation.html
products/cli/project-commands/remote-extension-managment.html: products/cli/project-commands/remote-extension-management.html
products/tools/cli/extension-commands/validation.html: products/tools/cli/validation.html
Comment thread
bojanrajh marked this conversation as resolved.
products/tools/cli/project-commands/remote-extension-managment.html: products/tools/cli/project-commands/remote-extension-management.html
products/paas/: products/paas/index.html
products/paas/cli-setup.html: products/paas/shopware-paas/cli-setup.html
products/paas/repository.html: products/paas/shopware-paas/repository.html
Expand Down Expand Up @@ -144,7 +144,7 @@ redirects:
concepts/framework/rules.html: concepts/framework/rule/index.html
products/extensions/migration-assistant/concept.html: products/extensions/migration-assistant/concept/index.html
products/extensions/migration-assistant/guides.html: products/extensions/migration-assistant/guides/index.html
products/cli/project-commands/project-config-sync.html: guides/development/tooling/fixture-bundle.html
products/tools/cli/project-commands/project-config-sync.html: guides/development/tooling/fixture-bundle.html
products/sales-agent/deployment.html: products/sales-agent/best-practices/app-deployment/hosted-with-ubuntu-server.html
guides/installation/requirements.html: guides/installation/system-requirements.html
guides/installation/setups/docker.html: guides/installation/legacy-setups/docker-setup.html
Expand Down Expand Up @@ -259,6 +259,7 @@ redirects:
resources/references/core-reference/rules-reference.html: guides/development/troubleshooting/rules-reference.html
guides/hosting/installation-updates/extension-managment.html: guides/hosting/installation-updates/extension-management.html
products/Nexus/: products/nexus/
products/cli/: products/tools/cli/
guides/installation/start-developing.html: guides/development/start-developing.html
concepts/translations/: concepts/framework/translations/

2 changes: 1 addition & 1 deletion guides/development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The Administration is part of the runtime environment and will be used throughou
## Development tooling

* `bin/console`: Shopware's built-in CLI, used for installing and activating plugins, running database migrations, clearing caches, executing scheduled tasks, and inspecting system state. See [command reference guide](../../resources/references/core-reference/commands-reference.md).
* The standalone [Shopware CLI](../../products/cli/installation.md) supports project scaffolding, CI/CD workflows, automation tasks, and more. See the [helper commands guide](../../products/cli/project-commands/helper-commands.md).
* The standalone [Shopware CLI](../../products/tools/cli/installation.md) supports project scaffolding, CI/CD workflows, automation tasks, and more. See the [helper commands guide](../../products/tools/cli/project-commands/helper-commands.md).
* IDE support: Shopware provides a [PHPStorm plugin](tooling/shopware-toolbox.md) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=shopware.shopware-lsp).
* [Deployment Helper](../hosting/installation-updates/deployments/deployment-helper.md): Supports database and maintenance operations for deployments (e.g., migrations, cache handling).

Expand Down
8 changes: 4 additions & 4 deletions guides/development/testing/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
## Cross-cutting practices

* Fail fast on coding standards and static analysis before slower E2E tests.
* Use the ([Shopware CLI formatter](../../../products/cli/formatter.md)) to keep code style consistent and run the bundled validation tools in CI using ([Shopware CLI validation tools](../../../products/cli/validation.md)).
* Use the[Shopware CLI formatter](../../../products/tools/cli/formatter.md) to keep code style consistent and run the bundled validation tools in CI using [Shopware CLI validation tools](../../../products/tools/cli/validation.md).
* Produce artifacts once per commit (ZIP for plugins, deployment-ready image/package for apps, built assets for projects) and promote the same artifact through stages.

## Custom projects

* Reuse the ([Project build command](../../../products/cli/project-commands/build.md)) to compile Storefront and Administration assets and warm caches. Run it in CI so deployments do not rebuild.
* Reuse the [Project build command](../../../products/tools/cli/project-commands/build.md) to compile Storefront and Administration assets and warm caches. Run it in CI so deployments do not rebuild.

Check warning on line 26 in guides/development/testing/ci.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] guides/development/testing/ci.md#L26

Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[3]) Suggestions: `, so` URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3 Category: PUNCTUATION
Raw output
guides/development/testing/ci.md:26:164: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[3])
 Suggestions: `, so`
 URL: https://languagetool.org/insights/post/types-of-sentences/#compound-sentence 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=3
 Category: PUNCTUATION
* Use environment-specific config only in deployment, not in CI. See [setup patterns](../../installation/index.md) you can mirror in pipelines.
* Add smoke tests against the HTTP layer plus DAL-level integration tests for custom entities.
* Cache Composer/NPM dependencies but keep lock files committed for deterministic builds.

## Custom/Store plugins

* Build and validate with `shopware-cli extension build` ([Extension build command](../../../products/cli/extension-commands/build.md) to ensure the ZIP is reproducible.
* Build and validate with [Extension build command](../../../products/tools/cli/extension-commands/build.md) to ensure the ZIP is reproducible.
* Run unit/integration tests with the Shopware test environment; keep fixtures inside the plugin to avoid coupling to project data.
* For Store plugins, add the Shopware Store validations early (linting, metadata, PHPStan) to catch review issues before submission ([Store submission via CLI](../../../products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md)).
* For Store plugins, add the Shopware Store validations early (linting, metadata, PHPStan) to catch review issues before submission [Store submission via CLI](../../../products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md).
2 changes: 1 addition & 1 deletion guides/development/testing/store/quality-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Validators and page types to test: [SEO and structured data](./seo-and-structure

### Tools

Use the [Shopware CLI](../../../../products/cli/index.md) to build, validate, and upload Shopware 6 plugin releases and to manage store descriptions and images.
Use the [Shopware CLI](../../../../products/tools/cli/index.md) to build, validate, and upload Shopware 6 plugin releases and to manage store descriptions and images.

## Final notes

Expand Down
2 changes: 1 addition & 1 deletion guides/development/tooling/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Shopware provides official tools that support the full lifecycle of a Shopware p

- For IDE support, Shopware provides a [PHPStorm plugin](shopware-toolbox.md) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=shopware.shopware-lsp).

- [Shopware CLI](../../../products/cli/index.md): The central command-line tool for working with Shopware projects and extensions, including scaffolding, builds, validation, packaging, Store interaction, CI support, and development workflows such as watchers and [formatting](../../../products/cli/formatter.md).
- [Shopware CLI](../../../products/tools/cli/index.md): The central command-line tool for working with Shopware projects and extensions, including scaffolding, builds, validation, packaging, Store interaction, CI support, and development workflows such as watchers and [formatting](../../../products/tools/cli/formatter.md).
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Ensure that the `mysqldump` and `mysql` binaries are from the same major version
We recommend using `shopware-cli project dump` to create a database dump, then importing it with the regular MySQL command. The CLI also includes an anonymization flag to ensure no personal data is in the staging environment.

::: info
`shopware-cli` is a separate Go command-line application with many useful commands for Shopware. [Learn how to install it](../../../../docs/products/cli/installation.md).
`shopware-cli` is a separate Go command-line application with many useful commands for Shopware. [Learn how to install it](../../../products/tools/cli/installation.md).
:::

```bash
Expand All @@ -65,7 +65,7 @@ shopware-cli project dump --clean --host localhost --username db_user --password
shopware-cli project dump --clean --anonymize --host localhost --username db_user --password db_pass --output shop.sql shopware
```

Configure the dump command with `.shopware-project.yml` to specify tables to skip, additional anonymization fields, and more. See the [CLI documentation](../../../../docs/products/cli/project-commands/mysql-dump.md) for details.
Configure the dump command with `.shopware-project.yml` to specify tables to skip, additional anonymization fields, and more. See the [CLI documentation](../../../products/tools/cli/project-commands/mysql-dump.md) for details.

### 3. Configuring the staging instance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,12 +332,12 @@ After the deployment, you can remove the extension from the source code, remove

In a Docker environment, you have a base image with a running PHP Webserver.
From that image you make a new image with your Shopware source code.
To prepare the Shopware source code, you can run [shopware-cli project ci](../../../../products/cli/) to install the dependencies and build the assets.
To prepare the Shopware source code, you can run [shopware-cli project ci](../../../../products/tools/cli/) to install the dependencies and build the assets.
On deployment, you spawn a second container or init a container, which runs the Deployment Helper.
The Deployment Helper sets up Shopware when it is not installed, installs the extensions and runs the one-time tasks.

### SFTP / Deployer

When using SFTP or Deployer, you clone the repository to the CI/CD server, run the [shopware-cli project ci](../../../../products/cli/) command to install the dependencies and build the assets.
When using SFTP or Deployer, you clone the repository to the CI/CD server, run the [shopware-cli project ci](../../../../products/tools/cli/) command to install the dependencies and build the assets.
Then you upload the source code to the server and run the Deployment Helper on the server.
The Deployment Helper sets up Shopware when it is not installed, installs the extensions and runs the one-time tasks.
2 changes: 1 addition & 1 deletion guides/hosting/installation-updates/deployments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Apply this approach to keep deployments deterministic and reduce environment-spe
Treat plugins as versioned deliverables that integrate cleanly into your deployment workflow (for e.g., via the [Deployment helper](deployment-helper.md)):

- Manage extensions via Composer whenever possible. Composer ensures versioned, reproducible installs during deployment.
- For Store submission or custom distribution workflows, build versioned ZIP artifacts from CI using the [Extension build command](../../../../products/cli/extension-commands/build.md). Install and activate them via CLI or deployment automation.
- For Store submission or custom distribution workflows, build versioned ZIP artifacts from CI using the [Extension build command](../../../../products/tools/cli/extension-commands/build.md). Install and activate them via CLI or deployment automation.
- Execute plugin migrations as part of deployment and ensure update steps are idempotent so that retries remain safe.
- For Store plugins in particular, avoid post-deployment manual tweaks.

Expand Down
2 changes: 1 addition & 1 deletion guides/hosting/installation-updates/performing-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Before any update, check if the installed extensions are compatible with the new
shopware-cli project upgrade-check
```

This command checks your installed extensions against the target Shopware version. If an extension is not compatible, check with the extension developer if an update is available. If you don't have the Shopware CLI installed, see the [installation guide](../../../products/cli/index.md).
This command checks your installed extensions against the target Shopware version. If an extension is not compatible, check with the extension developer if an update is available. If you don't have the Shopware CLI installed, see the [installation guide](../../../products/tools/cli/index.md).

Managing all extensions through Composer is the best way to ensure compatibility. It simplifies the update process as Composer automatically resolves the correct versions of the extensions.

Expand Down
4 changes: 2 additions & 2 deletions guides/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav:
# Shopware 6 Community Edition Installation

:::info
The recommended way for developers to build Shopware is with the Docker setup, made simple as of **March 2026** with a [Shopware CLI](./../../products/cli/index.md) installation path. Docker provides a consistent, production-like environment for development. Previous installation methods are available in the [Legacy Setups](./legacy-setups/index.md) section.
The recommended way for developers to build Shopware is with the Docker setup, made simple as of **March 2026** with a [Shopware CLI](../../products/tools/cli/index.md) installation path. Docker provides a consistent, production-like environment for development. Previous installation methods are available in the [Legacy Setups](./legacy-setups/index.md) section.
:::

Welcome to the Installation Guide for Shopware 6 Community Edition (CE)! This guide will help you set up a local Shopware 6 development environment, whether you’re:
Expand All @@ -27,7 +27,7 @@ Docker enables production-like conditions consistent across teams and CI/CD, and
## Prerequisites

- [Hardware requirements](./system-requirements.md): Ensure your system meets them (PHP, DB, memory, and so on) before you install
- [Shopware CLI](./../../products/cli/index.md)
- [Shopware CLI](../../products/tools/cli/index.md)
- Docker installed (recommended)

:::info
Expand Down
2 changes: 1 addition & 1 deletion guides/installation/legacy-setups/docker-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ apt install make
brew install make
```

This Docker setup includes the [Shopware CLI](../../../products/cli/index.md), which helps build, refactor, validate, and manage Shopware projects and extensions. It works with all setups and is used in most Shopware upgrade, build, and CI workflows. The CLI is available in the container shell.
This Docker setup includes the [Shopware CLI](../../../products/tools/cli/index.md), which helps build, refactor, validate, and manage Shopware projects and extensions. It works with all setups and is used in most Shopware upgrade, build, and CI workflows. The CLI is available in the container shell.

## Pre-pull Docker image (optional)

Expand Down
4 changes: 2 additions & 2 deletions guides/plugins/apps/administration/starter-admin-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This guide explains how to set up an extension for the Administration UI.
In order to follow this guide, make sure you are familiar with and meet the following requirements:

* Basic CLI usage (creating files, directories, running commands)
* Installed [shopware-cli](../../../../products/cli/) tools
* Installed [shopware-cli](../../../../products/tools/cli/) tools
* We will use the following libraries/software
* npm
* live-server (small local development live-reloading server)
Expand Down Expand Up @@ -144,7 +144,7 @@ For production usage, you should host the entry point file on a public CDN or a
In this last step, we will install the app using the Shopware CLI tools.

::: info
If this is your first time using the Shopware CLI, you have to [install](../../../../products/cli/installation) it first. Next, configure it using the `shopware-cli project config init` command.
If this is your first time using the Shopware CLI, you have to [install](../../../../products/tools/cli/installation) it first. Next, configure it using the `shopware-cli project config init` command.
:::

```bash
Expand Down
4 changes: 2 additions & 2 deletions guides/plugins/apps/app-scripts/add-api-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ After reading, you will be able to:

* A Shopware cloud store
* Basic CLI usage (creating files, directories, running commands)
* Installed and configured [shopware-cli](../../../../products/cli/index.md) tools
* Installed and configured [shopware-cli](../../../../products/tools/cli/index.md) tools
* General knowledge of [Twig Syntax](https://twig.symfony.com/)
* A text editor

Expand Down Expand Up @@ -131,7 +131,7 @@ Let's start with a simple script to see it in action:
Next we will install the App using the Shopware CLI.

::: info
If this is your first time using the Shopware CLI, you have to [install](../../../../products/cli/index.md) it first. Next, configure it using the `shopware-cli project config init` command.
If this is your first time using the Shopware CLI, you have to [install](../../../../products/tools/cli/index.md) it first. Next, configure it using the `shopware-cli project config init` command.
:::

Run this command from the root of the project directory.
Expand Down
4 changes: 2 additions & 2 deletions guides/plugins/apps/lifecycle/product-translator.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You will learn how to read and write data to the Shopware Admin API using an exa
## Prerequisites

* Basic CLI usage (creating files, directories, running commands)
* Installed [shopware-cli](../../../../products/cli/index.md) tools
* Installed [shopware-cli](../../../../products/tools/cli/index.md) tools
* Installed [symfony-cli](https://symfony.com/download)
* A running MariaDB or MySQL accessible to your development machine

Expand Down Expand Up @@ -446,7 +446,7 @@ class ProductUpdatedListener
In this last step, we will install the app using the Shopware CLI tools.

::: info
If this is your first time using the Shopware CLI, you have to [install](../../../../products/cli/index.md) it first. Next, configure it using the `shopware-cli project config init` command.
If this is your first time using the Shopware CLI, you have to [install](../../../../products/tools/cli/index.md) it first. Next, configure it using the `shopware-cli project config init` command.
:::

```sh
Expand Down
2 changes: 1 addition & 1 deletion guides/upgrades-migrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ To reduce long-term upgrade cost:
### Store plugins

* Align Store metadata (compatibility range, changelog) with the tested core versions; refuse installation on unsupported versions.
* Run Shopware Store validation on the new build before submission ([Store submission via CLI](../../products/cli/shopware-account-commands/releasing-extension-to-shopware-store.md)).
* Run Shopware Store validation on the new build before submission ([Store submission via CLI](../../products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md)).
* Communicate BC breaks explicitly.
* Prefer additive changes and feature flags to keep existing shops stable.

Expand Down
2 changes: 1 addition & 1 deletion products/paas/shopware-paas/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ shopware <paas-url>.git (push)

## Migrating from the old template to the new template

If you have already used the [Shopware PaaS old template](https://github.com/shopwareArchive/paas), please follow the guide to [migrate it to the new structure](../../../products/cli/project-commands/autofix.md#migrate-a-project-to-symfony-flex).
If you have already used the [Shopware PaaS old template](https://github.com/shopwareArchive/paas), please follow the guide to [migrate it to the new structure](../../tools/cli/project-commands/autofix.md#migrate-a-project-to-symfony-flex).

The following tasks have to be done additionally to the flex migration:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ shopware-cli extension fix /path/to/your/extension
shopware-cli project fix /path/to/your/project
```

Always back up or version your code before running refactoring commands, as they will modify files in place. [Learn more here](../../products/cli/automatic-refactoring.md).
Always back up or version your code before running refactoring commands, as they will modify files in place. [Learn more here](automatic-refactoring.md).

### Project commands

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion products/cli/index.md → products/tools/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nav:
- uploading and maintaining extensions in the Shopware Store
- running CI/CD pipelines for Shopware-based solutions

Shopware CLI runs on macOS, Linux, and via Docker. For system-level requirements (PHP, DB, memory, etc.) see the [General Requirements](../../guides/installation/system-requirements.md). Windows users should use WSL 2 or Docker. (See full [installation](../cli/installation.md) page for Windows details.)
Shopware CLI runs on macOS, Linux, and via Docker. For system-level requirements (PHP, DB, memory, etc.) see the [General Requirements](../../guides/installation/system-requirements.md). Windows users should use WSL 2 or Docker. (See full [installation](installation.md) page for Windows details.)

## Quickstart

Expand Down
File renamed without changes.
File renamed without changes.
Loading