Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 25, 2025

Adds user-facing documentation for the --skip-download flag introduced in the vip export sql command.

Changes

  • Created docs/export-sql-skip-download.md with comprehensive usage examples
  • Documented automation workflows, cloud storage integration, and custom download tool use cases
  • Included output format examples and important notes on URL expiration and behavior

Example Usage

# Get download URL without downloading
vip @example-app.production export sql --skip-download

# Store URL for automation
URL=$(vip @example-app.production export sql --skip-download 2>&1 | grep -o 'https://[^[:space:]]*')

# Pipe directly to cloud storage
wget -O - "$URL" | aws s3 cp - s3://my-bucket/backups/backup.sql.gz

The documentation is structured for integration into the WordPress VIP documentation site at https://docs.wpvip.com/vip-cli/.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

luismulinari and others added 5 commits November 14, 2025 09:29
Add --skip-download flag to allow users to retrieve the download URL for database backups without downloading the file. This is useful for automation scenarios where users want to handle the download separately.

Changes:
- Add skipDownload option to ExportSQLCommand
- Skip storage confirmation and download steps when flag is set
- Output download URL to console instead of downloading
- Update progress tracker to support additional info for steps
- Add test coverage for skip-download functionality
- Add example usage in command help
Simplify the description to focus on what the option does rather than
redundantly explaining that the URL is always printed.
Co-authored-by: rinatkhaziev <459254+rinatkhaziev@users.noreply.github.com>
@sonarqubecloud
Copy link

Copilot AI changed the title [WIP] Add --skip-download option to export sql command docs: add public-facing documentation for --skip-download option Nov 25, 2025
Copilot AI requested a review from rinatkhaziev November 25, 2025 20:58
Base automatically changed from export-sql/skip-download to trunk November 26, 2025 17:19
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.

3 participants