Back to Details

paperless

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Paperless-ngx

Paperless-ngx

Interact with Paperless-ngx document management system via CLI.
通过CLI与Paperless-ngx文档管理系统进行交互。

Setup

设置

Environment: 
~/.secrets.env
(PAPERLESS_URL, PAPERLESS_TOKEN) - loaded by wrapper.
环境变量：
~/.secrets.env
（PAPERLESS_URL、PAPERLESS_TOKEN）- 由包装器加载。

CLI Discovery

CLI 功能探索

Run 
paperless-cli --help
to see available commands. Run 
paperless-cli <command> --help
for detailed usage of any command.
运行
paperless-cli --help
查看可用命令。运行
paperless-cli <command> --help
获取任意命令的详细用法。

Capabilities

功能

The CLI supports:
  • Search: Full-text search with filters (date ranges, tags, correspondents)
  • Browse: List recent documents, inbox items
  • Read: Get document details and extracted text content
  • Organize: Add/remove tags, edit metadata (title, correspondent, type)
  • Find related: Discover similar documents
  • Download: Save original files locally
  • Metadata: List tags, correspondents, document types, stats
该CLI支持：
  • 搜索：带筛选条件的全文搜索（日期范围、标签、关联方）
  • 浏览：列出最近的文档、收件箱项目
  • 读取：获取文档详情和提取的文本内容
  • 整理：添加/移除标签、编辑元数据（标题、关联方、类型）
  • 查找相关文档：发现相似文档
  • 下载：将原始文件保存到本地
  • 元数据管理：列出标签、关联方、文档类型、统计数据

Workflow

工作流程

  1. Search or list to find documents
  2. Get document by ID to read full content
  3. Add/remove tags to organize
  4. Find similar documents for related items
  5. Download originals when needed
  1. 搜索或列出文档以找到目标文件
  2. 通过文档ID获取文档以读取完整内容
  3. 添加/移除标签进行整理
  4. 查找相似文档以获取相关项目
  5. 必要时下载原始文件

Notes

注意事项

  • Flags must come BEFORE positional arguments
  • Document IDs are integers returned from search/list results
  • 标志参数必须放在位置参数之前
  • 文档ID是搜索/列表结果中返回的整数