CLI (Private Beta)

Manage your PowerSync environment programmatically
NOTE: An API access token is required to use the CLI while it's in private beta. Contact the support team to get one provisioned.
The PowerSync CLI allows:
  • Managing instances (create, edit, stop, destroy)
  • Deploying sync rules to an instance
  • Generating client-side schema

Getting started

To start using the CLI, there are currently two options:
  1. 1.
    Use npx powersync
  2. 2.
    Message the team on Discord to receive a Tarball
To begin, run initialize:
npx powersync init


For more information on the available commands please refer to:

Known issues and limitations

  • When deploying sync rules from the CLI, the sync-rules.yaml file shown in the PowerSync Dashboard could be out of date. You can run the “Compare deployed sync rules” action in the Dashboard to review the latest deployed sync rules.
  • Certificates cannot currently be managed from the CLI.