Installation

Get up and running with Pulsabase in minutes by installing the CLI and your preferred SDK.

Install the CLI

The Pulsabase CLI is the main tool for managing your projects, syncing schemas, and deploying your app.

npm

npm install -g @pulsabase/cli

yarn

yarn global add @pulsabase/cli

pnpm

pnpm add -g @pulsabase/cli

Verify the installation:

pulsabase --version

Authenticate the CLI

Before using the CLI with a project, authenticate with your Pulsabase account:

pulsabase login

This opens a browser window using a secure OAuth2 PKCE flow. Your tokens are stored locally in ~/.pulsabase/credentials.json (with chmod 600 permissions).

Note

Your credentials file is automatically refreshed before it expires. You should only need to run pulsabase login once per machine.

Install an SDK

TypeScript / JavaScript

npm install @pulsabase/sdk reflect-metadata

Make sure experimentalDecorators and emitDecoratorMetadata are enabled in your tsconfig.json:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Also import reflect-metadata at the very top of your entry file (e.g. main.ts or index.ts):

import 'reflect-metadata';

Dart / Flutter

Add Pulsabase to your pubspec.yaml:

dependencies:
  pulsabase: ^1.0.0

Then run:

flutter pub get

Next Steps

• Quickstart — build your first app in 5 minutes
• Models & Decorators — define your data schema
• CLI Reference — all CLI commands and options