Installation

Install the core package

npm install @pii-mask/core

Or with pnpm:

pnpm add @pii-mask/core

Optional packages

# CLI for file processing
npm install -g @pii-mask/cli

# React bindings
npm install @pii-mask/react

# NLP-powered detection
npm install @pii-mask/nlp

Requirements

• Node.js 22 or later (core also runs in modern browsers without shims)
• TypeScript 5.x (recommended)

Substitute mode

If you want to use substitute mode (generates realistic fake data), install @faker-js/faker as a peer dependency:

npm install @faker-js/faker

Then pass it in — core never imports faker itself, so it's only bundled when you use it:

import { faker } from '@faker-js/faker';
import { createMasker } from '@pii-mask/core';

const masker = createMasker({ mode: 'substitute', faker });

Use @faker-js/faker 10.5.0 or later (earlier versions are affected by GHSA-qxc2-j82w-r537).

AI coding agents

All packages ship TanStack Intent skills that coding agents load on demand. Enable them once per project:

npx @tanstack/intent@latest install