CLI (Beta)

Manage your PowerSync Cloud environment programmatically

You can use the PowerSync CLI to manage your PowerSync Cloud instances from your machine. Specifically, you can:

• Manage your PowerSync instances (PowerSync Cloud)
• Validate and deploy sync rules to an instance from a local file
• Generate the client-side schema

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 the Dashboard, using the Create Personal Access Token action (search for it using the command palette).

Use the Revoke Personal Access Token action to revoke access.

Usage

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

npm: powersync

npm

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.
• 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.