Installation - rehydra.ai

CLI

For terminal usage without writing code:

npm install -g @rehydra/cli

bun add -g @rehydra/cli

pnpm add -g @rehydra/cli

See the CLI Guide for commands and options.

Node.js

Install the SDK from npm:

npm install rehydra

The NER model requires onnxruntime-node, which is included as an optional dependency and will be installed automatically on supported platforms.

SQLite Storage (Optional)

For persistent PII map storage with SQLite:

npm install better-sqlite3

Bun

Bun requires onnxruntime-web since onnxruntime-node is a native Node.js addon:

bun add rehydra onnxruntime-web

Usage is identical to Node.js — the library auto-detects the runtime.

Browser (with Bundler)

When using Vite, webpack, esbuild, or other modern bundlers:

npm install rehydra onnxruntime-web

The browser-safe entry point is automatically selected via conditional exports. This entry point excludes Node.js-specific modules like SQLite storage.

Vite Configuration

No special configuration needed. Vite automatically resolves the browser build.

Webpack Configuration

No special configuration needed. Webpack 5+ resolves conditional exports correctly.

Browser (without Bundler)

For direct browser usage without a bundler:

<script type="module">
  // Import directly from your dist folder or CDN
  import { createAnonymizer } from './node_modules/rehydra/dist/browser.js';
  
  // onnxruntime-web is automatically loaded from CDN when needed
</script>

Conditional Exports

The package uses conditional exports to provide the right build for each environment:

{
  "exports": {
    ".": {
      "browser": "./dist/browser.js",
      "node": "./dist/index.js",
      "default": "./dist/index.js"
    }
  }
}

Explicit Imports

If needed, you can explicitly import a specific build:

// Browser-only build (excludes SQLite, Node.js fs, etc.)
import { createAnonymizer } from 'rehydra/browser';

// Node.js build (includes everything)
import { createAnonymizer, SQLitePIIStorageProvider } from 'rehydra/node';

// SQLite storage only (Node.js only)
import { SQLitePIIStorageProvider } from 'rehydra/storage/sqlite';

// Streaming anonymization (Node.js/Bun only)
import { createAnonymizerStream } from 'rehydra/streaming';

// LLM proxy middleware (Node.js/Bun only)
import { wrapLLMClient, createRehydraProxy } from 'rehydra/proxy';

What’s Included

Browser Build Includes

All recognizers (email, phone, IBAN, credit card, etc.)
NER model support (with onnxruntime-web)
Semantic enrichment
InMemoryPIIStorageProvider
IndexedDBPIIStorageProvider
All crypto utilities

Browser Build Excludes

SQLitePIIStorageProvider (use IndexedDBPIIStorageProvider instead)
Node.js fs, path, os modules

Requirements

Environment	Version	Notes
Node.js	≥ 18.0.0	Uses native `onnxruntime-node`
Bun	≥ 1.0.0	Requires `onnxruntime-web`
Browsers	Chrome 86+, Firefox 89+, Safari 15.4+, Edge 86+	Uses OPFS for model storage

Verifying Installation

import { anonymizeRegexOnly } from 'rehydra';

const result = await anonymizeRegexOnly('Contact: test@example.com');
console.log(result.anonymizedText);
// "Contact: <PII type="EMAIL" id="1"/>"

If you see the anonymized output, installation is complete!

Next Steps

Quick Start

Learn the basics of using Rehydra

NER Detection

Set up the NER model for detecting names and locations

​CLI

​Node.js

​SQLite Storage (Optional)

​Bun

​Browser (with Bundler)

​Vite Configuration

​Webpack Configuration

​Browser (without Bundler)

​Conditional Exports

​Explicit Imports

​What’s Included

​Browser Build Includes

​Browser Build Excludes

​Requirements

​Verifying Installation

​Next Steps