Skip to content

Document CLI dry run - #619

Open
bean1352 wants to merge 10 commits into
mainfrom
docs/cli-environments
Open

bean1352 wants to merge 10 commits into
mainfrom
docs/cli-environments

Conversation

@bean1352

@bean1352 bean1352 commented Sep 3, 2026 •

Copy link
Copy Markdown
Contributor

Updates the CLI page for the dry run flag, from powersync-ja/powersync-cli#64.

  • --dry-run on the deploy commands: what the summary shows, and how to compare the full service.yaml with the deployed config.
  • The CLI prints the target instance before a deploy, so CI logs show which instance changed.

Closes #620

AI disclosure

I used Claude to research the codebase and implement the change. I reviewed and tested it myself.

@mintlify

mintlify Bot commented Sep 3, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
powersync 🟢 Ready View Preview Sep 21, 2026, 12:06 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@bean1352 bean1352 changed the title Document CLI targets and dry run Document CLI dry run Sep 16, 2026
@bean1352
bean1352 marked this pull request as ready for review September 16, 2026 10:46
@bean1352 bean1352 added the enhancement New feature or request label Sep 16, 2026
Comment thread tools/cli.mdx Outdated
Comment thread tools/cli.mdx Outdated
Comment thread tools/cli.mdx Outdated
Comment thread tools/cli.mdx
Comment thread tools/cli.mdx Outdated
Comment thread tools/cli.mdx Outdated
@benitav

benitav commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

I linked what looks like the corresponding divergence issue in the description so it closes with the PR #620 - however I have't confirmed if all the suggestions from the issue are valid and implemented in this PR, and I am also wondering if this #618 might also be worth documenting in this PR since both these features will probably be released at the same time?

@bean1352

Copy link
Copy Markdown
Contributor Author

I linked what looks like the corresponding divergence issue in the description so it closes with the PR #620 - however I have't confirmed if all the suggestions from the issue are valid and implemented in this PR, and I am also wondering if this #618 might also be worth documenting in this PR since both these features will probably be released at the same time?

I've now documented the target instance line too, which also shows before stop, destroy, compact and status. Issue #620 can close with this PR.

I've closed the PR that linked to issue #618 but included the resolution order fix in this PR.

This branch was successfully deployed

1 active deployment
staging — fe26726f Deployed Sep 21, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Divergence] CLI shows target instance before mutating commands and adds --dry-run to deploy (powersync-cli #64)

2 participants