Check that it works
Three quick tests, from simplest to most complete. None of them needs an AI account.
1. The built-in health check
pii-airlock doctorIt prints one line per check. Every line should start with [ok].
| Line | Meaning if it says fail |
|---|---|
| gateway dependencies | The gateway add-on is missing. Run pipx inject pii-airlock 'pii-airlock[proxy]'. |
| models | Name-spotting models are not installed. Run pii-airlock download-models. |
| mapping roundtrip | An internal self-test failed. Reinstall and report a bug if it persists. |
| hook daemon | Information only. It shows whether the speed-up helper for hooks is running. |
2. Hide and restore a sentence
Use obviously fake data.
echo "Contact John Smith at john@example.com" \
| pii-airlock scrub --map /tmp/test.pii-map.json -o /tmp/scrubbed.txt
cat /tmp/scrubbed.txtYou should see placeholders instead of the name and email:
Contact <PERSON_482913> at <EMAIL_ADDRESS_093117>Your numbers will differ. Now put the originals back:
pii-airlock restore /tmp/scrubbed.txt --map /tmp/test.pii-map.jsonContact John Smith at john@example.comWindows
Use a folder you own instead of /tmp, for example $env:TEMP\test.pii-map.json.
3. Only look, change nothing
pii-airlock detect notes.txtIt lists what it found, with a confidence score, without altering the file. Handy to see what would be hidden.
4. Test the gateway
Start pii-airlock proxy, then point your AI client at it as described in Other AI apps and SDKs. Send a message that includes a fake name and email. Your client should still show them. Your provider's dashboard or logs should show placeholders such as <EMAIL_ADDRESS_093117>.
Delete test mapping files
The mapping file holds the real values. Remove it when you finish: rm /tmp/test.pii-map.json.