# Redact

> Privacy redaction toolkit for images, PDFs, Word documents, and PowerPoint presentations. Use when the user needs to redact, mask, or replace sensitive/private information in files. Triggers: - Redacting or masking sensitive text in images, PDFs, documents, or presentations - Replacing names, phone numbers, IDs, or other PII in files - Processing privacy compliance for documents before sharing - Anonymizing content in visual files Supported formats: png/jpg images, PDF, docx/doc, pptx/ppt

- Skill: `skills-router/redact` (Agent Skill, multi-file: 8 files)
- Install (CLI): `npx skillmds@latest add skills-router/redact`
- Raw SKILL.md: https://api.skillmd.com/api/skills/skills-router/redact/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: skills-router (https://skillmd.com/u/skills-router)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/skills-router/redact

---


# Redact Skill

Privacy redaction toolkit using PPStructureV3 OCR for text detection and replacement.

## Scripts

| Script | Format | Command |
|--------|--------|---------|
| `read.py` | Images / PDF / Word / PowerPoint | `read.py <input> [--info] [--mode json]` |
| `redact-image.py` | Images (png, jpg, etc.) | `redact-image.py <input> <rules.csv> <output>` |
| `redact-pdf.py` | PDF | `redact-pdf.py <input> <rules.csv> <output>` |
| `redact-document.py` | Word (docx, doc) | `redact-document.py <input> <rules.csv> <output>` |
| `redact-presentation.py` | PowerPoint (pptx, ppt) | `redact-presentation.py <input> <rules.csv> <output>` |

## CSV Rules Format

```csv
target_text,replacement_text
张三,李四
手机号,
身份证号,
```

| Rule | Effect |
|------|--------|
| `原文本,新文本` | Replace with new text |
| `原文本,` | Empty = mask with █ (documents) or solid color block (images/PDF) |

## Masking Behavior

| Format | Empty Replacement |
|--------|-------------------|
| Images, PDF | Solid color block overlay |
| Word, PowerPoint | `█` characters (same length as target) |

## Read Features

`read.py` supports:

- Reading text from images, PDF, Word, and PowerPoint files
- OCR for image files and embedded images
- Page-aware output for PDF / Word / PowerPoint
- `--info` structured output:
  - `<page index="...">`
  - `<image format='markdown' type='ocr'>...</image>` for OCR text extracted from images

### JSON Output

Document-like files (`pdf`, `docx`, `doc`, `pptx`) output:

```json
{
  "type": "pptx",
  "pages": [
    {
      "page_index": 1,
      "content": [
        { "type": "text", "text": "..." },
        { "type": "image", "text": "ocr text..." }
      ]
    }
  ]
}
```

Image files output:

```json
{
  "type": "image",
  "content": "..."
}
```

## Features

| Feature | Image | PDF | Document | Presentation |
|---------|:-----:|:---:|:--------:|:------------:|
| Read text | ✅ | ✅ | ✅ | ✅ |
| JSON output | ✅ | ✅ | ✅ | ✅ |
| Text replacement | ✅ | ✅ | ✅ | ✅ |
| Solid color mask | ✅ | ✅ | - | - |
| █ character mask | - | - | ✅ | ✅ |
| OCR detection | ✅ | ✅ | ✅ (images) | ✅ (images) |
| Tables | - | ✅ | ✅ | ✅ |
| Headers/Footers | - | ✅ | ✅ | - |
| Embedded images | - | ✅ | ✅ | ✅ |

## Environment Setup

使用 [uv](https://docs.astral.sh/uv/) 安装依赖：

```bash
# 进入 skill 目录
cd skills/redact

# 同步依赖（自动创建虚拟环境并安装）
uv sync
```

## Dependencies

- Python 3.10+
- PaddleOCR / PPStructureV3
- python-docx, python-pptx, PyMuPDF, Pillow