You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/development/dev-environment.md
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,15 @@ Shopware CLI provides a fully integrated Docker-based development environment. A
13
13
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.
14
14
:::
15
15
16
-
## Starting the Environment
16
+
## Starting the environment
17
17
18
18
From your Shopware project root, run:
19
19
20
20
```bash
21
21
shopware-cli project dev
22
22
```
23
23
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.
25
25
26
26
To start without the interactive dashboard (for CI or scripting):
27
27
@@ -71,8 +71,7 @@ Use `↑`/`↓` to navigate sources and `enter` to select one. Scroll with `pgup
71
71
72
72
### Config tab (3)
73
73
74
-
Adjust your Docker environment without touching YAML:
75
-
74
+
The following table lists the settings you can change in the Config tab:
76
75
| Setting | Options |
77
76
|---------|---------|
78
77
|**PHP Version**|`8.2`, `8.3`, `8.4`, `8.5`|
@@ -82,15 +81,15 @@ When selecting `blackfire` or `tideways`, additional credential fields appear. S
82
81
83
82
After changing settings, select **Save & Regenerate** to update `compose.yaml`. Restart the environment for changes to take effect.
84
83
85
-
## Migrating from Legacy Setups
84
+
## Migrating from legacy setups
86
85
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.
88
87
89
-
### What Triggers the Wizard
88
+
### What triggers the wizard
90
89
91
90
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.
92
91
93
-
### What the Wizard Does
92
+
### What the wizard does
94
93
95
94
Walking through the setup wizard takes about a minute. Here's what happens at each step:
96
95
@@ -108,17 +107,17 @@ After you confirm, the wizard:
108
107
- Generates a new `compose.yaml` tailored to your project's dependencies
109
108
- Starts the Docker containers and runs the Shopware installer
110
109
111
-
### What Happens to Existing Files
110
+
### What happens to existing files
112
111
113
112
| File | What changes |
114
113
|------|-------------|
115
114
|`.shopware-project.yml`| Updated with `compatibility_date`, `environments`, and `docker` config |
116
115
|`.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 |
119
118
|`composer.json`| If `shopware/deployment-helper` isn't already present, it's added to `require`|
120
119
121
-
### After the Wizard Completes
120
+
### After the wizard completes
122
121
123
122
If `shopware/deployment-helper` was added to `composer.json`, you'll be prompted to run:
124
123
@@ -128,9 +127,9 @@ composer install
128
127
129
128
This pulls in the helper package, which the dashboard uses to run the Shopware installer. After that, the environment starts automatically.
130
129
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).
132
131
133
-
## Viewing Application Logs
132
+
## Viewing application logs
134
133
135
134
Inspect Shopware logs without opening the dashboard:
136
135
@@ -151,7 +150,7 @@ shopware-cli project logs -l
151
150
shopware-cli project logs --lines 50
152
151
```
153
152
154
-
## Running Shopware Commands
153
+
## Running Shopware commands
155
154
156
155
Use `shopware-cli project console` to run `bin/console` commands from your host — no need to shell into the container:
When using the Docker executor, commands automatically run inside the web container via `docker compose exec`.
165
164
166
-
## Docker Services
165
+
## Docker services
167
166
168
167
The CLI generates a `compose.yaml` tailored to your project:
169
168
@@ -220,7 +219,7 @@ The compose file inspects your `composer.lock` at generation time:
220
219
- `shopware/elasticsearch`→ adds **OpenSearch** with environment variables
221
220
- PHP version defaults to `8.3`, overridable in the Config tab
222
221
223
-
## Environment Executors
222
+
## Environment executors
224
223
225
224
The CLI abstracts command execution across environment types, configured per environment in `.shopware-project.yml`:
226
225
@@ -253,7 +252,7 @@ The web container exposes these ports by default:
253
252
| `9999` | Storefront Proxy |
254
253
| `5773` | IDE debugging |
255
254
256
-
## Configuration Reference
255
+
## Configuration reference
257
256
258
257
### .shopware-project.yml
259
258
@@ -279,7 +278,7 @@ environments:
279
278
password: shopware
280
279
```
281
280
282
-
### .shopware-project.local.yml
281
+
### `.shopware-project.local.yml`
283
282
284
283
Sensitive credentials are stored in `.shopware-project.local.yml` (add to `.gitignore`):
285
284
@@ -292,7 +291,7 @@ docker:
292
291
293
292
## Troubleshooting
294
293
295
-
### compose.yaml keeps getting reset
294
+
### `compose.yaml` keeps getting reset
296
295
297
296
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).
298
297
@@ -308,7 +307,7 @@ The development TUI's initialization wizard, which mirrors steps in Shopware's i
308
307
309
308
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).
310
309
311
-
## Next Steps
310
+
## Next steps
312
311
313
312
- [Start Developing](./start-developing.md) — What to do once your environment is running
314
313
- [Build Extensions](./extensions/index.md) — Create plugins, apps, and themes
Copy file name to clipboardExpand all lines: guides/development/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ The Administration is part of the runtime environment and will be used throughou
78
78
79
79
## Development tooling
80
80
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
82
82
*`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`.
83
83
* 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).
84
84
* IDE support: Shopware provides a [PHPStorm plugin](tooling/shopware-toolbox.md) and [VS Code extension](https://marketplace.visualstudio.com/items?itemName=shopware.shopware-lsp).
If the container can't reach `localhost`, try `host.docker.internal` or your host's LAN IP.
129
129
130
-
### Environment Variables
130
+
### Environment variables
131
131
132
132
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`).
133
133
134
-
## Shopware Account and Private Composer Packages
134
+
## Shopware account and private Composer packages
135
135
136
136
To install licensed extensions from Shopware's private Composer registry:
Copy file name to clipboardExpand all lines: guides/installation/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ cd my-shop
85
85
shopware-cli project dev
86
86
```
87
87
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.
89
89
90
90
For details, see the [Development Environment guide](../development/dev-environment.md).
Copy file name to clipboardExpand all lines: guides/installation/project-overview.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ You have just installed Shopware, and this section guides you through the fundam
11
11
12
12
## Development tooling
13
13
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:
15
15
16
16
- One-command start/stop of the entire stack
17
17
- 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
-[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**)
26
26
- linting and testing tools
27
27
28
28
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.
The version parameter can be also `latest` for the latest stable version or `dev-trunk` for the latest development version.
27
27
28
-
## Development Environment
28
+
## Development environment
29
29
30
30
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.
31
31
32
32
```bash
33
-
# Launch the interactive dashboard
33
+
# Launch the interactive development terminal user interface (TUI)
0 commit comments