Skip to content

Commands ​

A cheat sheet. Run any command with --help for the full list of options.

Setup and checks ​

CommandWhat it does
pii-airlock initGuided first-time setup
pii-airlock download-modelsDownload the language models (--lang fr,en to choose)
pii-airlock doctorHealth check
pii-airlock --versionShow the version

Clean text and files ​

CommandWhat it does
pii-airlock scrub [file]Replace personal data with placeholders. Reads standard input if no file is given.
pii-airlock restore [file] --map MPut the originals back using a map file
pii-airlock detect [file]List what would be found, change nothing

scrub options:

OptionMeaning
-o, --out FILEWrite to a file instead of the screen
--map FILEWhere to save the map used to restore
--no-mapOne-way cleanup
--encrypt-mapEncrypt the map for this computer
--lang fr,enLanguages to look for
--threshold 0.7Minimum confidence, 0 to 1
--formatForce text, csv, json, docx or pdf

Gateway ​

CommandWhat it does
pii-airlock proxyStart the gateway on 127.0.0.1:8745
pii-airlock proxy --port 8800Use another port
pii-airlock proxy --host 0.0.0.0Listen on all network interfaces. Only do this if you understand the exposure.
--openai-url, --anthropic-url, --gemini-urlSend to a different upstream address

Hooks (Claude Code and Copilot) ​

CommandWhat it does
pii-airlock install-hookInstall both hooks for this project
--scope userInstall for all projects
--event tool or --event promptInstall only one of the two
--target copilotInstall for GitHub Copilot instead of Claude Code
pii-airlock daemon status | start | stopControl the helper that keeps models loaded

Your rules ​

CommandWhat it does
pii-airlock allow "TERM"Never treat this as personal data
pii-airlock deny "TERM" --as LABELAlways treat this as sensitive
pii-airlock action TYPE tokenize|redact|allow|blockChoose what happens to a type
pii-airlock policy initCreate the project policy file
pii-airlock policy showShow the rules in force and their source
pii-airlock trustAccept this project's settings after reviewing them

allow, deny and action take --scope project (default) or --scope user.

Released under the MIT License.