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
9 changes: 9 additions & 0 deletions client-sdks/reference/capacitor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in Capacitor apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import CapacitorInstallation from '/snippets/capacitor/installation.mdx';
import JavaScriptAsyncWatch from '/snippets/basic-watch-query-javascript-async.mdx';
Expand Down Expand Up @@ -51,6 +52,14 @@ import LocalOnly from '/snippets/local-only-escape.mdx';

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Capacitor"
slug="client-sdks/reference/capacitor"
question="Which platforms am I targeting: iOS, Android, or web?"
/>

## Installation

<CapacitorInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/dotnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in .NET apps (beta)."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import DotNetInstallation from '/snippets/dotnet/installation.mdx';
import DotNetWatch from '/snippets/dotnet/basic-watch-query.mdx';
Expand Down Expand Up @@ -56,6 +57,14 @@ For more details, please refer to the package [README](https://github.com/powers

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk=".NET"
slug="client-sdks/reference/dotnet"
question="Which .NET version and app framework am I using (for example MAUI or a console app)? Check the supported frameworks and targets on the SDK reference first."
/>

## Quickstart

<DotNetInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/flutter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in Dart and Flutter apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import FlutterInstallation from '/snippets/flutter/installation.mdx';
import FlutterWatch from '/snippets/flutter/basic-watch-query.mdx';
Expand Down Expand Up @@ -43,6 +44,14 @@ Get started quickly by using the self-hosted **Flutter** + **Supabase** template
Web support is currently in a beta release. Refer to [Flutter Web Support](/client-sdks/frameworks/flutter-web-support) for more details.
</Note>

## AI Quickstart

<AiQuickstart
sdk="Dart/Flutter"
slug="client-sdks/reference/flutter"
question="Which platforms am I targeting: iOS, Android, web, or desktop? If web is one of them, follow the extra steps in https://docs.powersync.com/client-sdks/frameworks/flutter-web-support.md."
/>

## Installation

<FlutterInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/javascript-web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in JavaScript Web apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import JavaScriptWebInstallation from '/snippets/javascript-web/installation.mdx';
import JavaScriptAsyncWatch from '/snippets/basic-watch-query-javascript-async.mdx';
Expand Down Expand Up @@ -80,6 +81,14 @@ The PowerSync [JavaScript Web SDK](../javascript-web) is compatible with popular
</Accordion>


## AI Quickstart

<AiQuickstart
sdk="JavaScript Web"
slug="client-sdks/reference/javascript-web"
question="Which framework am I using (React, Vue, or plain JavaScript), and does the app need to stay in sync across multiple browser tabs?"
/>

## Installation

<JavaScriptWebInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/kotlin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in Kotlin Multiplatform apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import KotlinInstallation from '/snippets/kotlin/installation.mdx';
import KotlinWatch from '/snippets/kotlin/basic-watch-query.mdx';
Expand Down Expand Up @@ -32,6 +33,14 @@ import LocalOnly from '/snippets/local-only-escape.mdx';

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Kotlin Multiplatform"
slug="client-sdks/reference/kotlin"
question="Which targets does my app build for (for example Android and iOS), or is it Android-only?"
/>

## Installation

<KotlinInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in Node.js apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import NodeInstallation from '/snippets/node/installation.mdx';
import JavaScriptAsyncWatch from '/snippets/basic-watch-query-javascript-async.mdx';
Expand Down Expand Up @@ -44,6 +45,14 @@ import LocalOnly from '/snippets/local-only-escape.mdx';

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Node.js client"
slug="client-sdks/reference/node"
question="What kind of app is this (for example a CLI or a desktop app), and where should the local database file live? If I actually want to connect a Node.js backend that serves other PowerSync clients, stop and point me to https://docs.powersync.com/configuration/app-backend/setup.md instead."
/>

## Quickstart
<NodeInstallation />

Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/react-native-and-expo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in React Native (& Expo) apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import ReactNativeInstallation from '/snippets/react-native/installation.mdx';
import JavaScriptAsyncWatch from '/snippets/basic-watch-query-javascript-async.mdx';
Expand Down Expand Up @@ -45,6 +46,14 @@ A separate `powersync-react` package is available containing React hooks for Pow
/>


## AI Quickstart

<AiQuickstart
sdk="React Native & Expo"
slug="client-sdks/reference/react-native-and-expo"
question="Am I using Expo or bare React Native? If Expo, do I need to run the app in Expo Go during development?"
/>

## Installation

<ReactNativeInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Use PowerSync in Rust apps."
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import RustInstallation from '/snippets/rust/installation.mdx';
import RustWatchQuery from '/snippets/rust/basic-watch-query.mdx';
Expand Down Expand Up @@ -36,6 +37,14 @@ import LocalOnly from '/snippets/local-only-escape.mdx';

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Rust"
slug="client-sdks/reference/rust"
question="What kind of application is this, and how is the Rust code packaged into it?"
/>

## Installation

<RustInstallation />
Expand Down
9 changes: 9 additions & 0 deletions client-sdks/reference/swift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
sidebarTitle: "SDK Reference"
---

import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import SwiftInstallation from '/snippets/swift/installation.mdx';
import SwiftWatch from '/snippets/swift/basic-watch-query.mdx';
Expand All @@ -26,7 +27,7 @@
</CardGroup>

<Note>
Earlier versions of the Swift SDK (up to v1.13) shipped a PowerSync Kotlin XCFramework under the hood and abstracted it behind Swift protocols.

Check warning on line 30 in client-sdks/reference/swift.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/reference/swift.mdx#L30

Did you really mean 'XCFramework'?

From v1.14 onward, the Kotlin dependency has been removed entirely. The SDK is now implemented natively in Swift, with the PowerSync sync protocol and SQLite extension handled by our [Rust core](https://github.com/powersync-ja/powersync-sqlite-core).
</Note>
Expand All @@ -34,6 +35,14 @@
### SDK Features
<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Swift"
slug="client-sdks/reference/swift"
question="Which Apple platforms am I targeting, and am I using SwiftUI or UIKit?"
/>

## Installation

<SwiftInstallation />
Expand Down
10 changes: 9 additions & 1 deletion client-sdks/reference/tauri.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Use PowerSync in Tauri apps."
sidebarTitle: "SDK Reference"
---


import AiQuickstart from '/snippets/ai-quickstart.mdx';
import SdkFeatures from '/snippets/sdk-features.mdx';
import TauriInstallation from '/snippets/tauri/installation.mdx';
import JavaScriptAsyncWatch from '/snippets/basic-watch-query-javascript-async.mdx';
Expand Down Expand Up @@ -43,6 +43,14 @@ import MutationConfirmationWithReturning from '/snippets/javascript-mutation-con

<SdkFeatures />

## AI Quickstart

<AiQuickstart
sdk="Tauri"
slug="client-sdks/reference/tauri"
question="Do I need to read or write the database from Rust code as well as from JavaScript?"
/>

## Installation

<TauriInstallation />
Expand Down
38 changes: 37 additions & 1 deletion intro/powersync-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,46 @@ PowerSync is made up of the PowerSync Service and a set of client SDKs. The Powe
The architecture and the philosophy behind PowerSync.
</Card>
<Card title="AI Agent Skills" icon="sparkles" href="/tools/ai-tools#powersync-agent-skills" horizontal>
Official PowerSync skills for Claude Code, Convex, and other AI-powered coding tools.
Official PowerSync skills for Claude Code, Codex, and other AI-powered coding tools.
</Card>
</CardGroup>

## AI Quickstart

<Prompt description="Add **PowerSync** to your project" actions={["copy", "cursor"]} icon="sparkles">
```text
Add PowerSync to this project so the app reads and writes a local SQLite
database that syncs with my backend database.

Install the PowerSync Agent Skills in this project and follow them:

npx skills add powersync-ja/agent-skills

Inspect the project to identify my language and framework, then confirm the
matching PowerSync client SDK with me. PowerSync has SDKs for Flutter,
React Native & Expo, JavaScript Web, Capacitor, Node.js, Tauri, Kotlin
Multiplatform, Swift, .NET, and Rust. Use
https://docs.powersync.com/client-sdks/overview.md to find the SDK
reference, and check the PowerSync docs when something is unclear rather
than guessing. Do not invent APIs.

Ask me these questions and wait for my answers before writing code:

1. Which backend database am I syncing from: Postgres, MongoDB, MySQL, or
SQL Server? Am I on a hosted platform such as Supabase?
2. Do I have a PowerSync Service instance (PowerSync Cloud or self-hosted)?
If not, help me set one up first.
3. Which tables does my app need locally, and which rows should each user
receive?
4. How do users authenticate?

Then work step by step: define the client-side schema, write Sync Stream
definitions for the data I described and show me how to apply them on the
PowerSync Service, instantiate the PowerSync database, implement a backend
connector, and connect. Verify the app builds and syncs before you finish.
```
</Prompt>

## Supported Backend Source Databases

PowerSync is designed to be backend database agnostic, and supports these source databases:
Expand Down
29 changes: 29 additions & 0 deletions snippets/ai-quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
export const AiQuickstart = ({ sdk, slug, question }) => <></>;

<Prompt description="Add **PowerSync** to your project" actions={["copy", "cursor"]} icon="sparkles">
Set up PowerSync in this project using the PowerSync {sdk} SDK.

Install the PowerSync Agent Skills in this project and follow them:

npx skills add powersync-ja/agent-skills

Use https://docs.powersync.com/{slug}.md as the SDK reference. When
something is unclear, check the PowerSync docs or ask me. Do not invent

Check warning on line 11 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L11

Avoid first-person singular ('me'). Write instructions in second person.
APIs.

Ask me these questions and wait for my answers before writing code:

Check warning on line 14 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L14

Avoid first-person singular ('me'). Write instructions in second person.

Check warning on line 14 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L14

Avoid first-person singular ('my'). Write instructions in second person.

1. Which backend database am I syncing from: Postgres, MongoDB, MySQL, or
SQL Server? Am I on a hosted platform such as Supabase?

Check warning on line 17 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L17

Avoid first-person singular (' I '). Write instructions in second person.
2. Do I have a PowerSync Service instance (PowerSync Cloud or self-hosted)?

Check warning on line 18 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L18

Avoid first-person singular (' I '). Write instructions in second person.
If not, help me set one up first.

Check warning on line 19 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L19

Avoid first-person singular ('me'). Write instructions in second person.
3. Which tables does my app need locally, and which rows should each user

Check warning on line 20 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L20

Avoid first-person singular ('my'). Write instructions in second person.
receive?
4. How do users authenticate?
5. {question}

Then work step by step: define the client-side schema, write Sync Stream
definitions for the data I described and show me how to apply them on the

Check warning on line 26 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L26

Avoid first-person singular (' I '). Write instructions in second person.

Check warning on line 26 in snippets/ai-quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

snippets/ai-quickstart.mdx#L26

Avoid first-person singular ('me'). Write instructions in second person.
PowerSync Service, instantiate the PowerSync database, implement a backend
connector, and connect. Verify the app builds and syncs before you finish.
</Prompt>
4 changes: 4 additions & 0 deletions tools/ai-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Learn more:
PowerSync Agent Skills repository
</Card>

## Copyable Prompts

Each [client SDK reference](/client-sdks/overview) includes an AI Quickstart section with a prompt you can copy straight into your coding agent, or open in Cursor. The prompts install the Agent Skills in your project and have the agent ask about your backend database, PowerSync Service instance, data scoping, and authentication before it writes code. The [documentation home page](/intro/powersync-overview#ai-quickstart) has a version for projects where you haven't picked an SDK yet.

## AI-Accessible Documentation

### Markdown Documentation
Expand Down
Loading