feat(cli): document new Docker-based development environment#2286
Draft
Soner (shyim) wants to merge 5 commits into
Draft
feat(cli): document new Docker-based development environment#2286Soner (shyim) wants to merge 5 commits into
Soner (shyim) wants to merge 5 commits into
Conversation
Add comprehensive documentation for the new Manage your Shopware Project
Usage:
shopware-cli project [command]
Available Commands:
admin-api pre authenticated curl interface to the Admin API
admin-build Builds the Administration
admin-watch Starts the Shopware Admin Watcher
autofix Autofix a project
ci Build Shopware in the CI
clear-cache Clears the Shop cache
config Manage the project config
console Runs the Symfony Console (bin/console) for current project
create Create a new Shopware 6 project
doctor Check your Shopware project for potential problems
dump Dumps the Shopware database
extension Manage the extensions of the Shopware shop
fix Fix project
format Format project
generate-jwt Generate a new JWT secret key
image-proxy Start a proxy server for serving images from the public folder
storefront-build Builds the Storefront
storefront-watch Starts the Shopware Storefront Watcher
upgrade-check Check that installed extensions are compatible with a future Shopware version
validate Validate project
worker Run multiple Symfony worker in background.
Flags:
-h, --help help for project
--project-config string Path to config (default ".shopware-project.yml")
Global Flags:
-n, --no-interaction do not ask any interactive questions
--verbose show debug output
Use "shopware-cli project [command] --help" for more information about a command.
development environment introduced in shopware-cli. Covers:
- Interactive DevTUI dashboard with General, Logs, and Config tabs
- Background start/stop via and subcommands
- Setup wizard for projects migrating to dev mode
- command for viewing application logs
- Auto-generated compose.yaml with services, port mappings, and
auto-detection of queue/search dependencies
- Environment executor abstraction (docker, local, symfony-cli)
- Configuration reference for .shopware-project.yml and local overrides
- Troubleshooting guide
Also updates the start-developing guide, CLI index, and helper
commands page to reference the new development environment.
…e.yaml Add a dedicated section explaining that compose.yaml is fully managed by the CLI and will be regenerated, with practical compose.override.yaml examples for common customization use cases (extra env vars, ports, volumes, additional services). Strengthen the troubleshooting entry and config reference section with the same guidance.
The development environment documentation now lives in the main development guide as the primary workflow for developers: - New guides/development/dev-environment.md — comprehensive guide covering DevTUI dashboard, setup wizard, compose.override.yaml pattern, log streaming, configuration reference, troubleshooting - Restructured guides/development/start-developing.md — leads with the dev environment; old make shell workflow moved to legacy note - Updated guides/development/index.md — dev environment in workflow and tooling sections - Updated guides/installation/index.md — replaced make up/setup instructions with shopware-cli project dev as the way to start - Updated guides/installation/project-overview.md — mentions dev environment as standard interaction method - Updated guides/development/tooling/index.md — added dev environment - Slimmed products/cli/project-commands/dev-environment.md to a CLI command reference pointing to the main guide - Updated helper-commands.md to cross-reference the main guide
- Added DevTUI, LavinMQ, lavinmq, adminer, keypress, overridable, runnable, xdebug to .wordlist.txt - Fixed markdown linting: blank lines before code blocks and lists
Replace the brief 'Setup Wizard' section with a comprehensive 'Migrating from Legacy Setups' guide that explains: - What triggers the wizard (compatibility date before 2026-03-01) - Step-by-step walkthrough of each wizard screen - What files are created, updated, or replaced (with a table) - What happens to existing compose.yaml and Makefile - Post-migration steps (composer install if needed, moving customizations to compose.override.yaml)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new development environment introduced in (next branch), which adds a fully integrated Docker-based development environment with an interactive terminal dashboard.
Changes
products/cli/project-commands/dev-environment.md— comprehensive guide coveringproject dev,dev start/dev stop,project logs, the DevTUI dashboard, setup wizard, Docker services, environment executors, configuration reference, and troubleshootingproducts/cli/project-commands/helper-commands.md— added Development Environment sectionguides/development/start-developing.md— added "Using the Development Environment" sectionproducts/cli/index.md— added dev environment to feature list