docclear 是 DocClear 的命令行入口，提供与桌面端同一套本地脱敏引擎，适合脚本自动化、批量处理与 CI 集成。
全局用法
docclear [选项] [子命令]
选项
| 选项 | 说明 |
|---|
-i, --input <路径> | 输入 PDF 文件或目录（目录即批量） |
-o, --output <目录> | 输出目录 |
-c, --config <路径> | 配置文件路径，默认 config.toml |
-t, --template <名称> | 规则模板名称，如 builtin-pii、bidding-doc |
-m, --mode <模式> | 处理模式，默认 auto（见下表） |
--force-ocr | 强制走 OCR 链路 |
--report <路径> | 输出 JSON 格式的脱敏报告 |
--mapping <路径> | 输出假名映射表（仅假名模式） |
--list-templates | 列出所有可用规则模板 |
处理模式（—mode）
| 值 | 行为 |
|---|
auto | 自动识别 PDF 类型并路由（默认） |
text | 强制走文本 PDF 真删除链路（涂黑） |
scan | 强制走扫描件 OCR 链路（涂黑） |
mask | 字符掩码：张三 → 张*、13800138000 → 138****8000 |
pseudonym | 代号替换：张三 → 人物A，保留可还原映射表 |
子命令
scan —— 仅扫描，不修改文件
docclear scan -i ./docs -t builtin-pii --format json
| 参数 | 说明 |
|---|
-i, --input <路径> | 输入 PDF 文件或目录 |
-t, --template <名称> | 规则模板名称 |
--format <格式> | 输出格式：text（默认）/ json |
list-templates —— 列出可用模板
docclear list-templates
示例
# 整目录批量扫描，输出 JSON 命中明细
docclear scan -i ./contracts --format json
# 使用招投标模板执行掩码脱敏，同时输出脱敏报告
docclear -i ./bidding.pdf -o ./out -t bidding-doc -m mask --report report.json
# 假名化并保留映射表，授权后可回填还原
docclear -i ./contract.pdf -o ./out -m pseudonym --mapping mapping.json
配置文件
CLI 默认读取工作目录下的 config.toml，可通过 -c 指定其他路径，把规则与输出行为固化到仓库中随脚本复用。
