Installation

Varity Team Core Contributors Updated March 2026

Get your development environment ready for building with Varity.

System Requirements

Node.js 18.0 or later
Python 3.8 or later (for CLI)
npm, pnpm, or yarn
A modern browser (Chrome, Firefox, Safari, Edge)

Install Packages

Install the core packages
- npm
- pnpm
- yarn
Terminal window
npm install @varity-labs/sdk @varity-labs/ui-kit @varity-labs/types
Terminal window
pnpm add @varity-labs/sdk @varity-labs/ui-kit @varity-labs/types
Terminal window
yarn add @varity-labs/sdk @varity-labs/ui-kit @varity-labs/types
Install the CLI
Terminal window
```
pip install varitykit
```
Or with pipx (recommended for CLI tools):
Terminal window
```
pipx install varitykit
```

Verify installation

varitykit doctor

You should see output like:

✓ Python version: 3.11.0
✓ Node.js version: 20.0.0
✓ npm version: 10.0.0
✓ All checks passed!

Package Overview

@varity-labs/sdk

Core SDK with configuration, storage, database, and backend services.

npm install @varity-labs/sdk

@varity-labs/ui-kit

React components for authentication, accounts, payments, and dashboards.

npm install @varity-labs/ui-kit

@varity-labs/types

TypeScript type definitions for all Varity interfaces.

npm install @varity-labs/types

varitykit

Command-line tool for deploying and managing apps.

pip install varitykit

Environment Setup

No environment variables needed to get started. Varity manages all credentials automatically.

Framework Setup

Next.js (App Router)

import { PrivyStack } from '@varity-labs/ui-kit';

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>
        <PrivyStack appId={process.env.NEXT_PUBLIC_VARITY_APP_ID}>
          {children}
        </PrivyStack>
      </body>
    </html>
  );
}

React (Vite)

import React from 'react';
import ReactDOM from 'react-dom/client';
import { PrivyStack } from '@varity-labs/ui-kit';
import App from './App';

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <PrivyStack appId={import.meta.env.VITE_VARITY_APP_ID}>
      <App />
    </PrivyStack>
  </React.StrictMode>
);

Verify Setup

Create a simple test component:

import { usePrivy } from '@varity-labs/ui-kit';

export function TestConnection() {
  const { ready, authenticated } = usePrivy();

  if (!ready) {
    return <p>Loading...</p>;
  }

  return (
    <div>
      <p>Varity is connected!</p>
      <p>Authenticated: {authenticated ? 'Yes' : 'No'}</p>
    </div>
  );
}

If you see “Varity is connected!”, you’re ready to build.

Next Steps

Quick Start - Deploy your first app
Authentication - Add login to your app
CLI Reference - Learn the CLI commands

Troubleshooting

”Module not found” errors

Make sure you’ve installed all packages:

npm install @varity-labs/sdk @varity-labs/ui-kit @varity-labs/types

CLI not found

Make sure Python is in your PATH and try:

python -m pip install varitykit

TypeScript errors

Make sure you’re using TypeScript 5.0 or later:

npm install typescript@latest

For more help, see Troubleshooting or join our Discord.