Skip to content

Document CLI dry run - #619

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

bean1352 wants to merge 7 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 16, 2026, 11:04 AM

💡 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

The command prints the target instance, runs the deploy validations, and then summarizes what would change: the `service.yaml` sections that differ from the deployed config, and a diff of the Sync Config. Nothing is deployed.

If the instance is not provisioned yet, the dry run skips Sync Config validation, because that check runs against a running instance. The summary reports that a real deploy would provision the instance first, then validate and deploy the Sync Config.

@benitav benitav Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

If the instance is not provisioned yet, the dry run skips Sync Config validation, because that check runs against a running instance.

This seems useful to document so users understand the dependency

The summary reports that a real deploy would provision the instance first, then validate and deploy the Sync Config.

This seems unnecessary to document - why document the report output here unless there's something advanced in the report output that we might want to explain more here?

@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?

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