Skip to content

Commit 31beff8

Browse files
update readmes
1 parent 3e8c0ba commit 31beff8

File tree

6 files changed

+65
-3
lines changed

6 files changed

+65
-3
lines changed

cli/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
# powersync
22

3-
CLI for PowerSync
3+
Programmatically manage your PowerSync environment.
4+
5+
For an overview, see the docs [here](https://docs.powersync.com/tools/cli).
6+
7+
## Note: Beta Release
8+
9+
This package is currently in a beta release.
10+
11+
## Upgrading from 0.8.0
12+
13+
Version 0.9.0 and above are **not backwards compatible** with 0.8.0. If you are using the previous CLI commands and are not ready to migrate, you can continue using the old version:
14+
15+
```bash
16+
npm install -g @powersync/cli@0.8.0
17+
```
18+
19+
Otherwise, refer to the [docs](https://docs.powersync.com/tools/cli) for guidance on migrating to the new version.
420

521
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
622
[![Version](https://img.shields.io/npm/v/@powersync/cli.svg)](https://npmjs.org/package/@powersync/cli)
@@ -66,7 +82,7 @@ Set **`PS_ADMIN_TOKEN`** to your PAT. The CLI uses **`PS_ADMIN_TOKEN`** when set
6682

6783
```sh
6884
export PS_ADMIN_TOKEN=your-personal-access-token
69-
powersync fetch instances --project-id=<project-id>
85+
powersync fetch instances
7086
```
7187

7288
To stop using stored credentials, run **`powersync logout`**. This clears the stored token from the active backend (secure storage or config-file fallback).

packages/cli-core/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# @powersync/cli-core
2+
3+
Core types, base commands, and utilities shared across the PowerSync CLI and its plugins.
4+
5+
> **Internal use:** This package is intended for internal use by the PowerSync CLI and its bundled plugins. It is not part of the public API.
6+
>
7+
> **Plugin authors:** You can use `@powersync/cli-core` to build your own PowerSync CLI plugins, but treat this package as **experimental and subject to change**. There are no stability guarantees between releases — APIs, types, and base classes may be renamed, restructured, or removed without a deprecation period.
8+
9+
## What's in this package
10+
11+
- Base command classes (`PowerSyncCommand`, `InstanceCommand`, `SelfHostedInstanceCommand`) for building CLI commands and plugins.
12+
- Shared types (`SelfHostedProject`, `SelfHostedInstanceCommandFlags`, `EnsureConfigOptions`, etc.).
13+
- YAML helpers (`parseYamlFile`, `parseYamlDocumentPreserveTags`, `stringifyYaml`) for `!env`-aware config parsing.
14+
- Auth and project resolution utilities used by the CLI and official plugins.
15+
16+
## Usage in plugins
17+
18+
Import from `@powersync/cli-core` when authoring your own plugin:
19+
20+
```ts
21+
import { SelfHostedInstanceCommand, PowerSyncCommand } from '@powersync/cli-core';
22+
```
23+
24+
See `@powersync/cli-plugin-docker` for a reference implementation.

packages/editor/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# PowerSync CLI Config Studio
22

3+
> **Private package — not published to npm.** This package is built and bundled into [`@powersync/cli-plugin-config-edit`](../../plugins/config-edit) during the build step (`pnpm --filter editor build` copies the output into `plugins/config-edit/editor-dist/`). It is served at runtime by that plugin when you run `powersync edit config`. It is not intended to be installed or used directly.
4+
35
The PowerSync CLI Config Studio is the Monaco-powered editor that ships with the `powersync edit config` command. It exposes the two YAML files managed by the CLI (`service.yaml` and `sync-config.yaml`), enforces our official JSON Schemas, and lets you save the result back to your local PowerSync directory without touching the CLI manually.
46

57
## Feature highlights

packages/schemas/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# @powersync/cli-schemas
2+
3+
JSON Schema definitions and TypeScript types for PowerSync CLI configuration files (`service.yaml`, `sync-config.yaml`, `cli.yaml`).
4+
5+
> **Internal use:** This package is intended for internal use by the PowerSync CLI, its plugins, and the config editor. It is not part of the public API and may change without notice between releases.

plugins/config-edit/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# @powersync/cli-plugin-config-edit
2+
3+
> **Bundled plugin:** This plugin is automatically included in the `powersync` package. You do not need to install it separately — the `powersync edit config` command is available out of the box when you install `powersync`.
4+
5+
PowerSync CLI plugin that launches the Monaco-powered configuration editor for `service.yaml` and `sync-config.yaml`. It serves the `editor` package as a local web app and opens it in your browser.
6+
7+
## Usage
8+
9+
```bash
10+
powersync edit config --directory ./powersync
11+
```
12+
13+
See the `editor` package for details on how the editor works and how to develop it locally.

plugins/docker/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @powersync/cli-plugin-docker
22

3+
> **Bundled plugin:** This plugin is automatically included in the `powersync` package. You do not need to install it separately — all `powersync docker` commands are available out of the box when you install `powersync`.
4+
35
PowerSync CLI plugin that adds a **docker** topic for self-hosted instances: **configure**, **reset**, **start**, and **stop** using Docker Compose.
46

57
## Commands
@@ -17,7 +19,7 @@ All commands use the same project and directory resolution as the main CLI (e.g.
1719

1820
## Templates (composable modules)
1921

20-
Templates are organized by **category** and **implementation** (see also [usage-docker.md](../docs/usage-docker.md#how-configure-uses-templates)):
22+
Templates are organized by **category** and **implementation**:
2123

2224
- **`templates/source-database/`** – Replication source (e.g. **postgres**). Used by **`--database`**.
2325
- **`templates/bucket-storage/`** – PowerSync bucket metadata (e.g. **postgres**). Used by **`--storage`**.

0 commit comments

Comments
 (0)