Installation

How to install pii-mask packages.

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 18 or later
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

@faker-js/faker is optional and only loaded when mode: 'substitute' is used.

Introduction

What is pii-mask and why it exists.

Quick Start

Get started with pii-mask in under a minute.

On this page

Install the core package Optional packages Requirements Substitute mode