Client-Side Setup

Add the PowerSync pub.dev package to your project:

flutter pub add powersync

See the full SDK reference for further details and getting started instructions:

Add the PowerSync React Native NPM package to your project:

Run the below command in your project folder:

• npm
• yarn
• pnpm

npm npx expo install @powersync/react-native

See the full SDK reference for further details and getting started instructions:

Add the PowerSync JavaScript Web NPM package to your project:

• npm
• yarn
• pnpm

npm install @powersync/web

See the full SDK reference for further details and getting started instructions:

Add the PowerSync SDK to your project by adding the following to your build.gradle.kts file:

kotlin {
    //...
    sourceSets {
        commonMain.dependencies {
            api("com.powersync:core:$powersyncVersion")
            // If you want to use the Supabase Connector, also add the following:
            implementation("com.powersync:connectors:$powersyncVersion")
        }
        //...
    }
}

Cocoapods

We recommend using Cocoapods (as opposed to SMP) for iOS targets. Add the following to the cocoapods config in your build.gradle.kts

cocoapods {
    //...
    pod("powersync-sqlite-core") {
        linkOnly = true
    }

    framework {
        isStatic = true
        export("com.powersync:core")
    }
    //...
}

Note: The linkOnly attribute is set to true and framework is set to isStatic = true to ensure that the powersync-sqlite-core binaries are only statically linked.

See the full SDK reference for further details and getting started instructions:

1. Using Package.swift:

let package = Package(
    ...
    dependencies: [
        ...
        .package(
            url: "https://github.com/powersync-ja/powersync-swift",
            exact: "<version>"
        ),
    ],
    targets: [
        .target(
            name: "YourTargetName",
            dependencies: [
                .product(
                    name: "PowerSync",
                    package: "powersync-swift"
                )
            ]
        )
    ]
)

2. Using Xcode:

   1. Follow this guide to add a package to your project.

   2. When searching for the package use https://github.com/powersync-ja/powersync-swift.git as the URL and include the exact version e.g. 1.0.0-Beta.x as shown below:

See the full SDK reference for further details and getting started instructions: