Skip to content
capsule

Install Capsule SDK

Installing the Capsule Client SDK

You can easily integrate your application with Capsule using our client SDK.

Installation

Install the package using npm:

Terminal window
npm install @capsulesh/capsule-client

Or using yarn:

Terminal window
yarn add @capsulesh/capsule-client

Or using pnpm:

Terminal window
pnpm add @capsulesh/capsule-client

Basic Setup

Once installed, you can create a Capsule client instance:

import { createCapsuleClient, OAuthScopes } from "@capsulesh/capsule-client";


const client = createCapsuleClient({
  identifier: "my-app-v1.0.0",
  scopes: [OAuthScopes.PROFILE_READ],
  redirectUri: "https://my-app.com/callback",
});

Available Scopes

The SDK supports the following scopes:

ScopeDescription
PROFILE_READRead user profile information
TASKS_READRead user tasks
TASKS_WRITECreate and modify tasks
NOTES_READRead user notes
NOTES_WRITECreate and modify notes

Next Steps

After installation, you can:

  1. Handle user authentication
  2. Work with data models
  3. Create caplets and objects

Requirements

  • Node.js 16 or higher
  • Modern browser with ES6 support