[docs] Document new project sql, project upgrade commands and update notifications - #2454
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
This PR updates the Shopware CLI documentation to cover newly introduced user-facing behavior, specifically adding reference documentation for shopware-cli project sql and documenting the new background update notification opt-out.
Changes:
- Adds a new
project sqldocumentation page, including interactive usage, one-shot queries, and output formats. - Adds an “Update notifications” section to the CLI installation docs to document
--no-update-hintandSHOPWARE_CLI_NO_UPDATE_NOTIFICATION.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| products/tools/cli/project-commands/sql.md | New documentation page for shopware-cli project sql usage and output formats. |
| products/tools/cli/installation.md | Documents how to silence the CLI’s update notification via flag and env var. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Micha Hobert (Isengo1989)
left a comment
There was a problem hiding this comment.
LGTM 👍
Related to shopware/shopware-cli#1391 (by
@shyim).That PR merges back several user-facing CLI features that were previously undocumented:
shopware-cli project sqlcommand: opens an interactive SQL shell, runs a single query passed as an argument, or executes a script piped via stdin, against the current environment's database connection. Supports--format table|tsv|json.shopware-cli project upgradecommand: an interactive wizard that guides users through readiness checks, version selection, extension compatibility, and execution of a Shopware upgrade. Supports headless/CI usage via--no-interactionwith--target(accepting a version,recommended, orlatest-patch), plus--dry-runand--no-auditflags.--no-update-hintflag andSHOPWARE_CLI_NO_UPDATE_NOTIFICATIONenvironment variable to silence the CLI's new background update-check notification.None of these were previously documented, so this PR adds:
products/tools/cli/project-commands/sql.md— new page documentingproject sqlproducts/tools/cli/project-commands/upgrade.md— new page documentingproject upgradeproducts/tools/cli/installation.md— new "Update notifications" section documenting--no-update-hintandSHOPWARE_CLI_NO_UPDATE_NOTIFICATIONCommand names, flags, and defaults were taken directly from the source PR's diff (
cmd/project/project_sql.go,cmd/project/project_upgrade.go,cmd/root.go) to avoid inventing behavior.cc
@shyim