[docs] Clarify that -e/--env now applies to all Admin-API commands - #2458
[docs] Clarify that -e/--env now applies to all Admin-API commands#2458shopware-docs-updater[bot] wants to merge 2 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Developer Docs healthcheckStatus: Completed with |
📢 Developer Announcement RecommendationRecommendation: ❌ No Announcement Recommended No developer announcement signals were detected.
|
There was a problem hiding this comment.
Pull request overview
Updates the Shopware CLI documentation to reflect that the global -e/--env flag applies to all project commands that communicate with a shop (including Admin API–based commands), and that specifying an unknown environment now fails instead of silently falling back to the default configuration.
Changes:
- Documented that
-e/--envis honored by Admin API command families (not only executor-based commands). - Added explicit guidance + an example for selecting a named environment from
.shopware-project.yml. - Documented the new failure behavior for unknown environment names.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| products/tools/cli/project-commands/remote-extension-management.md | Adds a “Targeting an environment” section describing -e/--env, how it selects environments.<name> config, and the unknown-env failure behavior. |
| guides/development/dev-environment.md | Clarifies in the environment executors section that -e/--env affects Admin API command families too, and that unknown environment names now error. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Micha Hobert (Isengo1989)
left a comment
Micha Hobert (Isengo1989)
left a comment
There was a problem hiding this comment.
LGTM 👍
Related to shopware/shopware-cli#1257 (fix by
@moshimorschi).User-facing change
That PR fixed all
projectAdmin-API commands (extension list,extension uninstall,extension install,extension update,extension outdated,extension upload,extension delete,extension activate,extension deactivate,admin-api,clear-cache,upgrade check) to honor the global-e/--envflag and resolve the target environment from.shopware-project.yml. Previously, only executor-based commands (admin-build,ci,dev, ...) honored the flag; Admin-API commands silently used the base config, and an unknown environment name was silently ignored instead of causing a failure.Documentation gap
The docs did not mention that
-e/--envapplies to Admin-API commands, and did not document the "unknown environment fails" behavior at all.Files changed
docs/guides/development/dev-environment.md— noted that-e/--envselects the environment for all commands that talk to the shop (not just executor commands), and that an unknown name causes a failure.docs/products/tools/cli/project-commands/remote-extension-management.md— added a short "Targeting an environment" section with an example (shopware-cli project extension list -e staging) and a link back to the environment executors reference.Please review for accuracy against the merged behavior.