用途:面向自托管 Paperless-ngx 实例的读写操作技能,用于把实体或电子文档整理为可全文搜索的在线档案,并管理其元数据与组织维度。
主要能力:上传文档并触发自动 OCR 与元数据提取;按内容、标签、往来方、日期或文档类型搜索;列出与查看文档详情;下载/导出文档;更新标题、标签、往来方、文档类型与归档序列号;删除文档;管理标签与往来方;对多份文档执行批量加标签、移除标签、设置往来方、设置文档类型与批量删除。命令脚本统一返回 JSON,便于解析。
使用方式:前置条件为可访问的 Paperless-ngx 实例、从 UI 生成的 API 令牌,以及已安装 curl 和 jq。在 ~/.claude-homelab/.env 中配置 PAPERLESS_URL 与 PAPERLESS_API_TOKEN,并设置权限 chmod 600。令牌生成路径为 Settings → My Profile → API Tokens → Create Token。典型调用如 bash scripts/paperless-api.sh upload /path/to/document.pdf;bash scripts/paperless-api.sh search "invoice";bash scripts/tag-api.sh create "urgent" --color "#ff0000";bash scripts/bulk-api.sh add-tag <tag-id> --documents "1,2,3"。脚本凭证从 .env 自动读取,认证通过 Authorization: Token 请求头,基础路径为 /api/,API 版本 5,分页使用 page 与 page_size。
适用场景:维护家庭或团队文档的数字档案;按标签、往来方与文档类型分类;批量整理发票、合同、收据等;检索并导出指定文档。
限制与注意事项:属于自托管工具,使用前需有可运行的 Paperless-ngx 实例与有效令牌;上传后可自动 OCR 与建立全文索引,但具体识别效果未提供;删除操作会要求确认,删除文档将永久移除文件,删除标签或往来方仅解除关联;常见错误包括 401(检查令牌与权限)、404(检查 ID 与 URL)、400(元数据或文件问题)、连接被拒(实例未运行)。官方文档及其他参考文件路径已在资料中给出;本地配置的具体价格、托管平台与性能指标暂未提供。调用脚本时资料要求使用 pty: true,否则输出不可见。