Skip to content

Remove target instance paragraph from CLI command reference #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kobiebotha merged 4 commits into from
Oct 8, 2026
Merged

Remove target instance paragraph from CLI command reference #687

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a3e605
Polish cli status paragraph
bean1352 Oct 8, 2026
d553a2b
Wording tweak
bean1352 Oct 8, 2026
c327758
remove target instance paragraph from command reference
bean1352 Oct 8, 2026
4d53d09
reword ci sentence that referenced the removed paragraph
bean1352 Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions tools/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,6 @@ Then use the same commands as any self-hosted instance (`powersync status`, `pow
| `powersync stop --confirm=yes` | [Cloud] Stop instance (restart with deploy) |
| `powersync compact` | [Cloud] Trigger [bucket compacting](/maintenance-ops/compacting-buckets) on demand |

The CLI prints the instance it is about to act on before `powersync deploy`, `powersync stop`, `powersync destroy`, and `powersync compact` make any change, and at the start of `powersync status`. For a Cloud instance, the line shows the instance name with the instance, project, and organization IDs. For a self-hosted instance, it shows the API URL. Check this line before you confirm a destructive command.
Comment thread
bean1352 marked this conversation as resolved.

Run `powersync --help` or `powersync <command> --help` for flags. Full [command reference](https://github.com/powersync-ja/powersync-cli/blob/main/cli/README.md#commands) in the CLI repo.

## Deploying From CI (e.g. GitHub Actions)
Expand All @@ -282,7 +280,7 @@ You can automate Sync Config (and full config) deployments using the CLI in CI.

**Secrets:** Set `PS_ADMIN_TOKEN` to your PowerSync personal access token. If the workflow does not use a linked directory, also set `INSTANCE_ID`. For self-hosted, `API_URL` can specify the PowerSync API base URL.

The job log records the target instance line, so you can see which instance a run changed. For pull request checks, run `powersync deploy --dry-run` to validate the config and preview the changes without deploying.
The job log shows which instance the run changed. For pull request checks, run `powersync deploy --dry-run` to validate the config and preview the changes without deploying.

<Card title="GitHub Actions Demo" icon="github" horizontal href="https://github.com/powersync-community/github-actions-demo">
Example: deploy Sync Config on push to main
Expand Down
Loading