Skip to content

[docs] Document local proxy and dump row limits - #2464

Open
shopware-docs-updater[bot] wants to merge 2 commits into
mainfrom
docs/shopware-cli-1417-local-proxy-71263fba8b76b78c
Open

[docs] Document local proxy and dump row limits#2464
shopware-docs-updater[bot] wants to merge 2 commits into
mainfrom
docs/shopware-cli-1417-local-proxy-71263fba8b76b78c

Conversation

@shopware-docs-updater

Copy link
Copy Markdown

Documents user-facing features added in shopware/shopware-cli#1417 (merged by @shyim, authored by @tturkowski).

User-facing change

shopware-cli#1417 adds:

  • A new shopware-cli project proxy command group (setup, up, down, list, verify, teardown) providing a shared local reverse-proxy so multiple projects can run simultaneously under stable hostnames like (myshop.shopware.local/redacted) instead of fixed ports.
  • A new --local-domain flag (and interactive prompt) for shopware-cli project create to opt new projects into the proxy at creation time.
  • A new --limit flag for shopware-cli project dump (plus a persistent dump.limit key in .shopware-project.yml) to cap the number of exported rows for a table, with automatic foreign-key-aware filtering of referencing tables and self-reference ancestor handling.

None of this was previously documented, so this PR adds the missing coverage.

Documentation changes

  • products/tools/cli/project-commands/local-proxy.md (new) — overview of the local proxy feature, how to opt in for new/existing projects, and a command reference table.
  • products/tools/cli/project-commands/mysql-dump.md — added a "Limiting the number of rows" section documenting --limit and the dump.limit config key.
  • guides/development/dev-environment.md — added a short "Local domains" section cross-linking to the new local proxy page.

No pages were moved or renamed, so no redirects are required.

Generated by 📝 PR documentation check for #1417 · auto · 64.8 AIC · ⌖ 3.48 AIC · ⊞ 7.6K ·

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

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

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: fa81802
Preview: https://developer-documentation-18o69jq4s-shopware-frontends.vercel.app
Workflow run: #4975

@shyim

Copy link
Copy Markdown
Member

Copilot can you revert everything except "products/tools/cli/project-commands/mysql-dump.md"

Co-authored-by: shyim <6224096+shyim@users.noreply.github.com>

Copilot AI commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Copilot can you revert everything except "products/tools/cli/project-commands/mysql-dump.md"

Done — reverted guides/development/dev-environment.md and removed products/tools/cli/project-commands/local-proxy.md. Only the mysql-dump.md changes remain.

Copilot AI requested a review from Soner (shyim) August 21, 2026 05:00
@shyim
Soner (shyim) marked this pull request as ready for review August 21, 2026 05:02
Copilot AI lite review requested due to automatic review settings August 21, 2026 05:02
@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.

1 similar comment
@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.

@shyim
Soner (shyim) requested review from Su (sushmangupta) and removed request for Copilot August 21, 2026 05:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants