# redacted-cli

> Redacting classified documents CLI

Latest version **1.0.18** (published 2026-09-14) · BSD-2-Clause-Patent license · 0 weekly downloads

## Install

```sh
npm install redacted-cli
pnpm add redacted-cli
yarn add redacted-cli
bun add redacted-cli
```

Provides the command `redacted`.

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.18 |
| Published | 2026-09-14 |
| First published | 2023-03-13 |
| Weekly downloads | 0 |
| License | BSD-2-Clause-Patent |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Cyril Dever |
| Maintainers | cdever |
| Keywords | data, obfuscation, data masking, redacted, classified, cli, command-line interface |

## Links

- npm: https://www.npmjs.com/package/redacted-cli
- Repository: https://github.com/cyrildever/redacted
- Homepage: https://github.com/cyrildever/redacted/cli#readme
- Issues: https://github.com/cyrildever/redacted/issues
- npm.io page: https://npm.io/package/redacted-cli

## Dependencies (4)

- [figlet](https://npm.io/package/figlet.md) ^1.11.4
- [commander](https://npm.io/package/commander.md) ^15.0.0
- [redacted-ts](https://npm.io/package/redacted-ts.md) ^1.0.14
- [feistel-cipher](https://npm.io/package/feistel-cipher.md) ^1.6.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.18 (latest) — 2026-09-14
- 1.0.17 — 2026-08-25
- 1.0.16 — 2026-06-11
- 1.0.15 — 2026-03-12
- 1.0.14 — 2026-01-05
- 1.0.13 — 2025-12-15
- 1.0.12 — 2025-01-31
- 1.0.11 — 2024-12-21
- 1.0.10 — 2024-12-12
- 1.0.9 — 2024-12-12
- 1.0.8 — 2024-09-11
- 1.0.7 — 2024-02-08
- 1.0.6 — 2023-10-30
- 1.0.5 — 2023-09-27
- 1.0.4 — 2023-06-12
- … 4 more at https://npm.io/package/redacted-cli/versions

## README

# redacted-cli
_A TypeScript-based CLI to redacting classified documents_

![npm](https://img.shields.io/npm/v/redacted-cli?label=tag)
![GitHub last commit](https://img.shields.io/github/last-commit/cyrildever/redacted)
![GitHub issues](https://img.shields.io/github/issues/cyrildever/redacted)
![npm](https://img.shields.io/npm/dw/redacted-cli)
![NPM](https://img.shields.io/npm/l/redacted-cli)

For more details, see the [`redacted-ts`](../README.md) library.

### Install

```console
$ npm install -g redacted-cli
$ redacted -V
```


### Usage

```console
$ redacted --help
  ____          _            _           _ 
 |  _ \ ___  __| | __ _  ___| |_ ___  __| |
 | |_) / _ \/ _` |/ _` |/ __| __/ _ \/ _` |
 |  _ <  __/ (_| | (_| | (__| ||  __/ (_| |
 |_| \_\___|\__,_|\__,_|\___|\__\___|\__,_|
                                           
Usage: redacted [options]

A TypeScript-based CLI to redacting classified documents

Options:
  -V, --version             output the version number
  -b, --both                add to use both dictionary and tag
  -d, --dictionary <value>  the optional path to the dictionary of words to redact
  -H, --hash <value>        the hash engine for the round function (default "sha-256")
  -i, --input <value>       the path to the document to be redacted
  -k, --key <value>         the optional key for the FPE scheme (leave it empty to use default)
  -o, --output <value>      the name of the output file
  -r, --rounds <value>      the number of rounds for the Feistel cipher (default 10)
  -t, --tag <value>         the optional tag that prefixes words to redact (default "~")
  -x, --expand              add to expand a redacted document
  -h, --help                display help for command
```

eg.
```console
$ redacted -i myInputFile.txt -o myRedactedFile.txt -d myDictionary.txt -b
$ redacted -x -i myRedactedFile.txt -o myExpandedResult.txt -d myDictionary.txt -b
```

_NB: The dictionary file must consist of space-separated words._


### License

The use of the `redacted` libraries and executables are subject to fees for commercial purpose and to the respect of the [BSD-2-Clause-Patent license](LICENSE). \
Please [contact me](mailto:cdever@pep-s.com) to get further information.


<hr />
&copy; 2023-2026 Cyril Dever. All rights reserved.

---
_Source: https://npm.io/package/redacted-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._