Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 33 additions & 31 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ $ npm install -g powersync
$ powersync COMMAND
running command...
$ powersync (--version)
powersync/0.9.0 darwin-arm64 node-v24.13.0
powersync/0.9.1 darwin-arm64 node-v24.13.0
$ powersync --help [COMMAND]
USAGE
$ powersync COMMAND
Expand Down Expand Up @@ -388,7 +388,7 @@ EXAMPLES
$ powersync configure ide
```

_See code: [src/commands/configure/ide.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/configure/ide.ts)_
_See code: [src/commands/configure/ide.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/configure/ide.ts)_

## `powersync deploy`

Expand All @@ -397,11 +397,12 @@ _See code: [src/commands/configure/ide.ts](https://github.com/powersync-ja/power
```
USAGE
$ powersync deploy [--deploy-timeout <value>] [--directory <value>] [--instance-id <value> --project-id
<value>] [--org-id <value>]
<value>] [--org-id <value>] [--skip-sync-config-validation]

FLAGS
--deploy-timeout=<value> [default: 300] Seconds to wait after scheduling a deploy before timing out while polling
status (default 300 seconds).
--deploy-timeout=<value> [default: 300] Seconds to wait after scheduling a deploy before timing out while
polling status (default 300 seconds).
--skip-sync-config-validation Skip sync config validation and continue with the deploy.

PROJECT FLAGS
--directory=<value> [default: powersync] Directory containing PowerSync config. Defaults to "powersync". This is
Expand All @@ -428,7 +429,7 @@ EXAMPLES
$ powersync deploy --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/deploy/index.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/deploy/index.ts)_
_See code: [src/commands/deploy/index.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/deploy/index.ts)_

## `powersync deploy service-config`

Expand Down Expand Up @@ -465,7 +466,7 @@ EXAMPLES
$ powersync deploy service-config --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/deploy/service-config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/deploy/service-config.ts)_
_See code: [src/commands/deploy/service-config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/deploy/service-config.ts)_

## `powersync deploy sync-config`

Expand All @@ -474,11 +475,12 @@ _See code: [src/commands/deploy/service-config.ts](https://github.com/powersync-
```
USAGE
$ powersync deploy sync-config [--deploy-timeout <value>] [--directory <value>] [--instance-id <value> --project-id
<value>] [--org-id <value>] [--sync-config-file-path <value>]
<value>] [--org-id <value>] [--skip-sync-config-validation] [--sync-config-file-path <value>]

FLAGS
--deploy-timeout=<value> [default: 300] Seconds to wait after scheduling a deploy before timing out while
polling status (default 300 seconds).
--skip-sync-config-validation Skip sync config validation and continue with the deploy.
--sync-config-file-path=<value> Path to a sync config file. If provided, this file will be validated and deployed
instead of the default sync-config.yaml.

Expand All @@ -504,7 +506,7 @@ EXAMPLES
$ powersync deploy sync-config --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/deploy/sync-config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/deploy/sync-config.ts)_
_See code: [src/commands/deploy/sync-config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/deploy/sync-config.ts)_

## `powersync destroy`

Expand Down Expand Up @@ -541,7 +543,7 @@ EXAMPLES
$ powersync destroy --confirm=yes
```

_See code: [src/commands/destroy.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/destroy.ts)_
_See code: [src/commands/destroy.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/destroy.ts)_

## `powersync docker configure`

Expand Down Expand Up @@ -579,7 +581,7 @@ EXAMPLES
$ powersync docker configure --database=postgres --storage=postgres
```

_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/docker/configure.ts)_
_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/docker/configure.ts)_

## `powersync docker reset`

Expand Down Expand Up @@ -608,7 +610,7 @@ EXAMPLES
$ powersync docker reset
```

_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/docker/reset.ts)_
_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/docker/reset.ts)_

## `powersync docker start`

Expand Down Expand Up @@ -636,7 +638,7 @@ EXAMPLES
$ powersync docker start
```

_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/docker/start.ts)_
_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/docker/start.ts)_

## `powersync docker stop`

Expand Down Expand Up @@ -678,7 +680,7 @@ EXAMPLES
$ powersync docker stop --project-name=powersync_myapp --remove
```

_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/docker/stop.ts)_
_See code: [@powersync/cli-plugin-docker](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/docker/stop.ts)_

## `powersync edit config`

Expand Down Expand Up @@ -720,7 +722,7 @@ EXAMPLES
$ powersync edit config --directory ./powersync
```

_See code: [@powersync/cli-plugin-config-edit](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/edit/config.ts)_
_See code: [@powersync/cli-plugin-config-edit](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/edit/config.ts)_

## `powersync fetch config`

Expand Down Expand Up @@ -757,7 +759,7 @@ EXAMPLES
$ powersync fetch config --output=json
```

_See code: [src/commands/fetch/config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/fetch/config.ts)_
_See code: [src/commands/fetch/config.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/fetch/config.ts)_

## `powersync fetch instances`

Expand Down Expand Up @@ -785,7 +787,7 @@ EXAMPLES
$ powersync fetch instances --project-id=<id> --output=json
```

_See code: [src/commands/fetch/instances.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/fetch/instances.ts)_
_See code: [src/commands/fetch/instances.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/fetch/instances.ts)_

## `powersync fetch status`

Expand Down Expand Up @@ -830,7 +832,7 @@ EXAMPLES
$ powersync fetch status --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/fetch/status.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/fetch/status.ts)_
_See code: [src/commands/fetch/status.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/fetch/status.ts)_

## `powersync generate schema`

Expand Down Expand Up @@ -874,7 +876,7 @@ EXAMPLES
$ powersync generate schema --output=dart --output-path=lib/schema.dart --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/generate/schema.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/generate/schema.ts)_
_See code: [src/commands/generate/schema.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/generate/schema.ts)_

## `powersync generate token`

Expand Down Expand Up @@ -920,7 +922,7 @@ EXAMPLES
$ powersync generate token --subject=user-123 --expires-in-seconds=3600
```

_See code: [src/commands/generate/token.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/generate/token.ts)_
_See code: [src/commands/generate/token.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/generate/token.ts)_

## `powersync help [COMMAND]`

Expand Down Expand Up @@ -966,7 +968,7 @@ EXAMPLES
$ powersync init cloud --directory=powersync
```

_See code: [src/commands/init/cloud.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/init/cloud.ts)_
_See code: [src/commands/init/cloud.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/init/cloud.ts)_

## `powersync init self-hosted`

Expand All @@ -993,7 +995,7 @@ EXAMPLES
$ powersync init self-hosted --directory=powersync
```

_See code: [src/commands/init/self-hosted.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/init/self-hosted.ts)_
_See code: [src/commands/init/self-hosted.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/init/self-hosted.ts)_

## `powersync link cloud`

Expand Down Expand Up @@ -1032,7 +1034,7 @@ EXAMPLES
$ powersync link cloud --instance-id=<id> --project-id=<project-id> --org-id=<org-id>
```

_See code: [src/commands/link/cloud.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/link/cloud.ts)_
_See code: [src/commands/link/cloud.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/link/cloud.ts)_

## `powersync link self-hosted`

Expand Down Expand Up @@ -1060,7 +1062,7 @@ EXAMPLES
$ powersync link self-hosted --api-url=https://powersync.example.com
```

_See code: [src/commands/link/self-hosted.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/link/self-hosted.ts)_
_See code: [src/commands/link/self-hosted.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/link/self-hosted.ts)_

## `powersync login`

Expand All @@ -1081,7 +1083,7 @@ EXAMPLES
$ powersync login
```

_See code: [src/commands/login.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/login.ts)_

## `powersync logout`

Expand All @@ -1101,7 +1103,7 @@ EXAMPLES
$ powersync logout
```

_See code: [src/commands/logout.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/logout.ts)_
_See code: [src/commands/logout.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/logout.ts)_

## `powersync migrate sync-rules`

Expand Down Expand Up @@ -1138,7 +1140,7 @@ DESCRIPTION
Migrates Sync Rules to Sync Streams
```

_See code: [src/commands/migrate/sync-rules.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/migrate/sync-rules.ts)_
_See code: [src/commands/migrate/sync-rules.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/migrate/sync-rules.ts)_

## `powersync plugins`

Expand Down Expand Up @@ -1464,7 +1466,7 @@ EXAMPLES
$ powersync pull instance --instance-id=<id> --project-id=<id> --org-id=<org-id>
```

_See code: [src/commands/pull/instance.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/pull/instance.ts)_
_See code: [src/commands/pull/instance.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/pull/instance.ts)_

## `powersync status`

Expand Down Expand Up @@ -1509,7 +1511,7 @@ EXAMPLES
$ powersync status --instance-id=<id> --project-id=<id>
```

_See code: [src/commands/status.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/status.ts)_
_See code: [src/commands/status.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/status.ts)_

## `powersync stop`

Expand Down Expand Up @@ -1546,7 +1548,7 @@ EXAMPLES
$ powersync stop --confirm=yes
```

_See code: [src/commands/stop.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/stop.ts)_
_See code: [src/commands/stop.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/stop.ts)_

## `powersync validate`

Expand Down Expand Up @@ -1591,6 +1593,6 @@ EXAMPLES
$ powersync validate --api-url=https://powersync.example.com
```

_See code: [src/commands/validate.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.0/src/commands/validate.ts)_
_See code: [src/commands/validate.ts](https://github.com/powersync-ja/powersync-cli/blob/v0.9.1/src/commands/validate.ts)_

<!-- commandsstop -->
Loading