Skip to content

[docs] Document new project sql, project upgrade commands and update notifications - #2454

Open
shopware-docs-updater[bot] wants to merge 4 commits into
mainfrom
docs/cli-1391-sql-upgrade-update-hint-419d5710d74441a9
Open

[docs] Document new project sql, project upgrade commands and update notifications#2454
shopware-docs-updater[bot] wants to merge 4 commits into
mainfrom
docs/cli-1391-sql-upgrade-update-hint-419d5710d74441a9

Conversation

@shopware-docs-updater

Copy link
Copy Markdown

Related to shopware/shopware-cli#1391 (by @shyim).

That PR merges back several user-facing CLI features that were previously undocumented:

  • A new shopware-cli project sql command: 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.
  • A new shopware-cli project upgrade command: 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-interaction with --target (accepting a version, recommended, or latest-patch), plus --dry-run and --no-audit flags.
  • A new global --no-update-hint flag and SHOPWARE_CLI_NO_UPDATE_NOTIFICATION environment 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 documenting project sql
  • products/tools/cli/project-commands/upgrade.md — new page documenting project upgrade
  • products/tools/cli/installation.md — new "Update notifications" section documenting --no-update-hint and SHOPWARE_CLI_NO_UPDATE_NOTIFICATION

Command 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

Generated by 📝 PR documentation check for #1391 · auto · 47.9 AIC · ⌖ 6.02 AIC · ⊞ 7.6K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 18, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with failure.
Repository: shopware/docs
Commit: 2e981cc
Preview: No Vercel preview URL was found in the workflow logs.
Workflow run: #4880

@shyim Soner (shyim) self-assigned this Aug 18, 2026
@shyim
Soner (shyim) marked this pull request as ready for review August 18, 2026 05:42
Copilot AI lite review requested due to automatic review settings August 18, 2026 05:42
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 sql documentation page, including interactive usage, one-shot queries, and output formats.
  • Adds an “Update notifications” section to the CLI installation docs to document --no-update-hint and SHOPWARE_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.

Comment thread products/tools/cli/installation.md
Comment thread products/tools/cli/project-commands/sql.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants