Skip to main content
You can use the PowerSync CLI to manage your PowerSync Cloud instances from your machine. Specifically, you can:
The PowerSync CLI is not yet compatible with managing self-hosted PowerSync instances (PowerSync Open Edition and PowerSync Enterprise Self-Hosted Edition). This is on our roadmap.

​
Getting started

To begin, initialize the CLI via npx: 
npx powersync init

​
Personal Access Token

npx powersync init

? Enter your API token: [hidden]
You need to provide an access (API) token to initialize the CLI. These can be created in your Account Settings in the PowerSync Dashboard. Here you can also revoke access by deleting the token.

​
Usage

For more information on the CLI’s available commands, please refer to:

npm: powersync

npm

​
Deploying Sync Rules with GitHub Actions

You can automate sync rule deployments using the PowerSync CLI in your CI/CD pipeline. This is useful for ensuring your sync rules are automatically deployed whenever changes are pushed to a repository.

GitHub Actions Demo

See a complete example of deploying sync rules with GitHub Actions
 The example repository demonstrates how to:
  • Set up a GitHub Actions workflow to deploy sync rules on push to the main branch
  • Configure required repository secrets (POWERSYNC_AUTH_TOKEN, POWERSYNC_INSTANCE_ID, POWERSYNC_PROJECT_ID, POWERSYNC_ORG_ID)
  • Automatically deploy sync-rules.yaml changes

​
Known issues and limitations

  • Certificates cannot currently be managed from the CLI.
  • The PowerSync CLI is not yet compatible with managing self-hosted PowerSync instances (PowerSync Open Edition and PowerSync Enterprise Self-Hosted Edition). This is on our roadmap.