Skip to content

Commit 76cde53

Browse files
shyimlasomethingsomethingCopilot
authored
Apply suggestions from code review
Co-authored-by: somethings <l.apple@shopware.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent d08c3e8 commit 76cde53

7 files changed

Lines changed: 39 additions & 40 deletions

File tree

guides/development/dev-environment.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Shopware CLI provides a fully integrated Docker-based development environment. A
1313
The development environment requires a compatibility date of `2026-03-01` or later in your `.shopware-project.yml`. Projects created with `shopware-cli project create` have this set automatically.
1414
:::
1515

16-
## Starting the Environment
16+
## Starting the environment
1717

1818
From your Shopware project root, run:
1919

2020
```bash
2121
shopware-cli project dev
2222
```
2323

24-
This launches the interactive **DevTUI** dashboard. If your containers aren't running yet, the dashboard starts them. If Shopware hasn't been installed, it guides you through the installation wizard.
24+
This launches the development terminal user interface (TUI). If your containers aren't running yet, the dashboard starts them. If Shopware hasn't been installed, it guides you through the installation wizard.
2525

2626
To start without the interactive dashboard (for CI or scripting):
2727

@@ -71,8 +71,7 @@ Use `↑`/`↓` to navigate sources and `enter` to select one. Scroll with `pgup
7171

7272
### Config tab (3)
7373

74-
Adjust your Docker environment without touching YAML:
75-
74+
The following table lists the settings you can change in the Config tab:
7675
| Setting | Options |
7776
|---------|---------|
7877
| **PHP Version** | `8.2`, `8.3`, `8.4`, `8.5` |
@@ -82,15 +81,15 @@ When selecting `blackfire` or `tideways`, additional credential fields appear. S
8281

8382
After changing settings, select **Save & Regenerate** to update `compose.yaml`. Restart the environment for changes to take effect.
8483

85-
## Migrating from Legacy Setups
84+
## Migrating from legacy setups
8685

87-
If your project was created before March 2026 and uses the older `make up`/`make setup` workflow with a hand-written `compose.yaml`, running `shopware-cli project dev` automatically detects this and launches a **setup wizard** instead of the dashboard.
86+
If your project was created before March 2026 and uses the older `make up`/`make setup` workflow with a hand-written `compose.yaml`, running `shopware-cli project dev` automatically detects this and launches a setup wizard instead of the dashboard.
8887

89-
### What Triggers the Wizard
88+
### What triggers the wizard
9089

9190
The wizard appears when your project's `compatibility_date` in `.shopware-project.yml` is before `2026-03-01` (or missing entirely). This signals that the project hasn't been configured for the new development environment yet.
9291

93-
### What the Wizard Does
92+
### What the wizard does
9493

9594
Walking through the setup wizard takes about a minute. Here's what happens at each step:
9695

@@ -108,17 +107,17 @@ After you confirm, the wizard:
108107
- Generates a new `compose.yaml` tailored to your project's dependencies
109108
- Starts the Docker containers and runs the Shopware installer
110109

111-
### What Happens to Existing Files
110+
### What happens to existing files
112111

113112
| File | What changes |
114113
|------|-------------|
115114
| `.shopware-project.yml` | Updated with `compatibility_date`, `environments`, and `docker` config |
116115
| `.shopware-project.local.yml` | Created if you chose a profiler with credentials (Blackfire, Tideways) |
117-
| `compose.yaml` | **Replaced** with the CLI-managed version. Your old file is overwritten back it up first. Move any customizations to `compose.override.yaml`. |
118-
| `Makefile` | **Not touched**. You can delete it once you've migrated, or keep it around |
116+
| `compose.yaml` | **Replaced** with the CLI-managed version - your old file is overwritten, so back it up first and move any customizations to `compose.override.yaml` |
117+
| `Makefile` | **Not touched** - you can delete it once you've migrated, or keep it around |
119118
| `composer.json` | If `shopware/deployment-helper` isn't already present, it's added to `require` |
120119

121-
### After the Wizard Completes
120+
### After the wizard completes
122121

123122
If `shopware/deployment-helper` was added to `composer.json`, you'll be prompted to run:
124123

@@ -128,9 +127,9 @@ composer install
128127

129128
This pulls in the helper package, which the dashboard uses to run the Shopware installer. After that, the environment starts automatically.
130129

131-
Once migrated, the legacy `make up`/`make down`/`make setup` workflow is no longer needed use `shopware-cli project dev` to manage your environment instead. If you had customizations in your old `compose.yaml`, move them to `compose.override.yaml` before running the wizard (or recover them from git afterwards).
130+
Once migrated, the legacy `make up`/`make down`/`make setup` workflow is no longer needed; use `shopware-cli project dev` to manage your environment instead. If you had customizations in your old `compose.yaml`, move them to `compose.override.yaml` before running the wizard (or recover them from git afterwards).
132131

133-
## Viewing Application Logs
132+
## Viewing application logs
134133

135134
Inspect Shopware logs without opening the dashboard:
136135

@@ -151,7 +150,7 @@ shopware-cli project logs -l
151150
shopware-cli project logs --lines 50
152151
```
153152

154-
## Running Shopware Commands
153+
## Running Shopware commands
155154

156155
Use `shopware-cli project console` to run `bin/console` commands from your host — no need to shell into the container:
157156

@@ -163,7 +162,7 @@ shopware-cli project console dal:refresh:index
163162

164163
When using the Docker executor, commands automatically run inside the web container via `docker compose exec`.
165164

166-
## Docker Services
165+
## Docker services
167166

168167
The CLI generates a `compose.yaml` tailored to your project:
169168

@@ -220,7 +219,7 @@ The compose file inspects your `composer.lock` at generation time:
220219
- `shopware/elasticsearch` → adds **OpenSearch** with environment variables
221220
- PHP version defaults to `8.3`, overridable in the Config tab
222221

223-
## Environment Executors
222+
## Environment executors
224223

225224
The CLI abstracts command execution across environment types, configured per environment in `.shopware-project.yml`:
226225

@@ -253,7 +252,7 @@ The web container exposes these ports by default:
253252
| `9999` | Storefront Proxy |
254253
| `5773` | IDE debugging |
255254

256-
## Configuration Reference
255+
## Configuration reference
257256

258257
### .shopware-project.yml
259258

@@ -279,7 +278,7 @@ environments:
279278
password: shopware
280279
```
281280

282-
### .shopware-project.local.yml
281+
### `.shopware-project.local.yml`
283282

284283
Sensitive credentials are stored in `.shopware-project.local.yml` (add to `.gitignore`):
285284

@@ -292,7 +291,7 @@ docker:
292291

293292
## Troubleshooting
294293

295-
### compose.yaml keeps getting reset
294+
### `compose.yaml` keeps getting reset
296295

297296
This is by design. `compose.yaml` is fully managed and regenerated on config changes. Use `compose.override.yaml` for all customizations. See [Customizing with compose.override.yaml](#customizing-with-composeoverrideyaml).
298297

@@ -308,7 +307,7 @@ The development TUI's initialization wizard, which mirrors steps in Shopware's i
308307

309308
Set `compatibility_date: '2026-03-01'` in `.shopware-project.yml`. For more context, see the [build command docs](../../products/tools/cli/project-commands/build.md#compatibility-date).
310309

311-
## Next Steps
310+
## Next steps
312311

313312
- [Start Developing](./start-developing.md) — What to do once your environment is running
314313
- [Build Extensions](./extensions/index.md) — Create plugins, apps, and themes

guides/development/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The Administration is part of the runtime environment and will be used throughou
7878

7979
## Development tooling
8080

81-
* [Development Environment](./dev-environment.md) — Docker-based environment with an interactive terminal dashboard, log streaming, and runtime configuration
81+
* [Development Environment](./dev-environment.md) — Docker-based environment with an interactive terminal user interface (TUI), log streaming, and runtime configuration
8282
* `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). You can run these from your host with `shopware-cli project console`.
8383
* 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).
8484
* IDE support: Shopware provides a [PHPStorm plugin](tooling/shopware-toolbox.md) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=shopware.shopware-lsp).

guides/development/start-developing.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ nav:
99

1010
This guide covers what to do once your [development environment](./dev-environment.md) is running.
1111

12-
## Your Environment
12+
## Your environment
1313

1414
Once the containers are up, you have:
1515

1616
- **Storefront**: `http://127.0.0.1:8000`
1717
- **Administration**: `http://127.0.0.1:8000/admin` *(default credentials: `admin` / `shopware`)*
1818

19-
The DevTUI dashboard (`shopware-cli project dev`) shows these URLs and your credentials at a glance.
19+
The development terminal user interface (TUI) (`shopware-cli project dev`) shows these URLs and your credentials at a glance.
2020

2121
Common development areas:
2222

@@ -47,7 +47,7 @@ make shell
4747
docker compose exec web bash
4848
```
4949

50-
Most tasks are now easier with `shopware-cli project console` and the DevTUI dashboard.
50+
Most tasks are now easier with `shopware-cli project console` and the development TUI.
5151
:::
5252

5353
## Frontend development
@@ -86,18 +86,18 @@ shopware-cli project admin-build --only-custom-static-extensions
8686

8787
For more details, see [Using Watchers](./tooling/using-watchers.md).
8888

89-
## Administration Setup
89+
## Administration setup
9090

9191
When accessing the Administration for the first time:
9292

9393
- Sign in or create a Shopware account (required to install Store extensions)
94-
- Connect to the **Shopware Store**
94+
- Connect to the Shopware Store
9595
- Install plugins or themes from the Store
9696
- Configure payment methods if needed
9797

9898
Basic shop settings (name, language, currency) can be changed later under **Settings > Shop > Basic information**.
9999

100-
## Environment Customization
100+
## Environment customization
101101

102102
### compose.override.yaml
103103

@@ -117,7 +117,7 @@ services:
117117
- "3306:3306" # Expose MySQL to host
118118
```
119119
120-
### Connecting to a Remote Database
120+
### Connecting to a remote database
121121
122122
To use an external database, set `DATABASE_URL` in `.env.local`:
123123

@@ -127,11 +127,11 @@ DATABASE_URL="mysql://user:password@<host>:3306/<database>"
127127

128128
If the container can't reach `localhost`, try `host.docker.internal` or your host's LAN IP.
129129

130-
### Environment Variables
130+
### Environment variables
131131

132132
Create a `.env` file in the project root to override defaults. Most changes apply immediately. Changes to `APP_ENV` require a restart (`shopware-cli project dev stop && shopware-cli project dev start`).
133133

134-
## Shopware Account and Private Composer Packages
134+
## Shopware account and private Composer packages
135135

136136
To install licensed extensions from Shopware's private Composer registry:
137137

@@ -141,7 +141,7 @@ composer config --global http-basic.packages.shopware.com <username> <token>
141141

142142
Create an access token in your Shopware account under **Shops > Licenses**.
143143

144-
## Next Steps
144+
## Next steps
145145

146146
- [Build Extensions](./extensions/index.md) — Create plugins, apps, and themes
147147
- [Work with APIs](./integrations-api/index.md) — Integrate external systems

guides/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ cd my-shop
8585
shopware-cli project dev
8686
```
8787

88-
This launches the interactive **DevTUI** dashboard. The dashboard starts your Docker containers, runs the Shopware installer (first time only), and gives you an overview of your environment — Shop URLs, credentials, watchers, logs, and service configuration — all in one place.
88+
This launches the development terminal user interface (TUI). The dashboard starts your Docker containers, runs the Shopware installer (first time only), and gives you an overview of your environment — Shop URLs, credentials, watchers, logs, and service configuration — all in one place.
8989

9090
For details, see the [Development Environment guide](../development/dev-environment.md).
9191

guides/installation/project-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You have just installed Shopware, and this section guides you through the fundam
1111

1212
## Development tooling
1313

14-
The Docker setup provisions Shopware for development. The recommended way to manage your environment is through the [Development Environment](../development/dev-environment.md) dashboard (`shopware-cli project dev`), which provides:
14+
The Docker setup provisions Shopware for development. The recommended way to manage your environment is through the [Development Environment](../development/dev-environment.md) terminal user interface (TUI), available via `shopware-cli project dev`. It provides:
1515

1616
- One-command start/stop of the entire stack
1717
- Real-time log streaming from `var/log/` and Docker containers
@@ -22,7 +22,7 @@ The Docker setup provisions Shopware for development. The recommended way to man
2222
Development tools such as:
2323

2424
- [`shopware/dev-tools`](https://github.com/shopware/dev-tools)
25-
- [Symfony profiler]( https://symfony.com/doc/current/profiler.html) (**only in development mode**)
25+
- [Symfony profiler](https://symfony.com/doc/current/profiler.html) (**only in development mode**)
2626
- linting and testing tools
2727

2828
are managed via the Shopware CLI. These are installed into the user's environment and shared across projects and extensions, rather than being added as project-level `require-dev` dependencies.

products/tools/cli/project-commands/dev-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This page is a quick reference for the `shopware-cli project dev` and `shopware-
1111

1212
## Commands
1313

14-
### Start the Environment
14+
### Start the environment
1515

1616
```bash
1717
# Interactive dashboard (default when run in a terminal)
@@ -33,7 +33,7 @@ The interactive dashboard has three tabs:
3333
- **Instance** — containers, watcher processes, and log files with live-streaming
3434
- **Config** — PHP version, profiler
3535

36-
### View Application Logs
36+
### View application logs
3737

3838
```bash
3939
# Last 100 lines of the most recently modified log file
@@ -74,7 +74,7 @@ environments:
7474
password: shopware
7575
```
7676
77-
## Further Reading
77+
## Further reading
7878
7979
- [Development Environment guide](../../../../guides/development/dev-environment.md) — full workflow, setup wizard, service overview, troubleshooting
8080
- [Start Developing](../../../../guides/development/start-developing.md) — next steps after your environment is running

products/tools/cli/project-commands/helper-commands.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ shopware-cli project create <folder-name> <version>
2525

2626
The version parameter can be also `latest` for the latest stable version or `dev-trunk` for the latest development version.
2727

28-
## Development Environment
28+
## Development environment
2929

3030
Shopware CLI provides a fully integrated Docker-based development environment. See the [Development Environment](../../../../guides/development/dev-environment.md) guide for the full workflow, or the [CLI command reference](./dev-environment.md) for a quick overview.
3131

3232
```bash
33-
# Launch the interactive dashboard
33+
# Launch the interactive development terminal user interface (TUI)
3434
shopware-cli project dev
3535

3636
# Start/stop in the background

0 commit comments

Comments
 (0)