No description
Find a file
2026-04-25 23:48:59 +08:00
.planning docs: complete v1.4 code health research — stack, features, architecture, pitfalls synthesis 2026-04-25 23:48:59 +08:00
command feat(phase-10): add consistency audit script 2026-04-24 18:06:35 +08:00
docs docs(11-01): update AGENTS.md and ARCHITECTURE.md for path normalization 2026-04-24 20:45:18 +08:00
paperforge feat(update): smart update with auto-detection + Windows one-click script 2026-04-25 00:17:54 +08:00
scripts feat(update): smart update with auto-detection + Windows one-click script 2026-04-25 00:17:54 +08:00
tests fix(v1.3-doctor): update worker_script path and doctor checks for v1.3 architecture 2026-04-25 00:02:53 +08:00
.gitignore chore: remove user data and old files from repo 2026-04-25 00:25:37 +08:00
AGENTS.md docs: clarify dual-mode command invocation in AGENTS.md and README.md 2026-04-25 00:37:54 +08:00
paperforge.json Fix configurable Lite setup paths 2026-04-23 01:44:13 +08:00
pyproject.toml refactor(phase-9): rename paperforge_lite package to paperforge 2026-04-24 16:15:13 +08:00
README.md docs: clarify dual-mode command invocation in AGENTS.md and README.md 2026-04-25 00:37:54 +08:00
requirements.txt fix: add textual to requirements.txt 2026-04-23 00:09:00 +08:00
setup_wizard.py feat(phase-12): extract worker modules from literature_pipeline.py 2026-04-24 22:32:25 +08:00

PaperForge Lite

基于 Obsidian + Zotero + PaddleOCR 的医学文献精读工作流,支持自动 OCR、深度阅读笔记生成和队列管理。

    ______  ___  ______ _________________ ___________ _____  _____ 
    | ___ \/ _ \ | ___ \  ___| ___ \  ___|  _  | ___ \  __ \|  ___|
    | |_/ / /_\ \| |_/ / |__ | |_/ / |_  | | | | |_/ / |  \/| |__  
    |  __/|  _  ||  __/|  __||    /|  _| | | | |    /| | __ |  __| 
    | |   | | | || |   | |___| |\ \| |   \ \_/ / |\ \| |_\ \| |___ 
    \_|   \_| |_/\_|   \____/\_| \_\_|    \___/\_| \_|\____/\____/ 

快速开始(推荐方式)

PaperForge 提供交互式安装向导,引导你完成全部配置:

# 1. 克隆仓库
git clone https://github.com/LLLin000/PaperForge.git
cd PaperForge

# 2. 运行向导(交互式,按步骤引导)
python setup_wizard.py --vault /path/to/your/vault

向导会自动完成:

  • 检测 Python 环境和依赖
  • 安装 PaperForge 工具包(pip install -e . 由向导自动执行)
  • 配置 Vault 目录结构(可自定义名称)
  • 链接 Zotero 数据目录
  • 检测 Better BibTeX 插件
  • 配置 JSON 自动导出
  • 部署工作流脚本和 Agent 命令
  • 创建 .env 配置文件

功能特性

  • 交互式安装向导 — 步骤引导,自动检测,安全验证
  • /pf-deep — 深度精读Keshav 三阶段阅读法)
  • 自动 OCR 提取 — PaddleOCR-VL API 提取全文和图表
  • 图表类型智能识别 — 20 种图表类型自动检测
  • 图表质量审查指南 — 14 种图表类型的专业审查清单
  • Zotero 双向同步 — Better BibTeX 自动导出
  • 文献队列管理 — Obsidian Base 集成
  • 自动更新python literature_pipeline.py --vault . update

安装要求

  • Python 3.10+
  • Zotero + Better BibTeX 插件
  • Obsidian
  • PaddleOCR API Key安装后配置

目录结构

your-vault/
├── [资源目录]/                  # 安装时可自定义
│   └── [文献索引目录]/
│       └── library-records/     # 文献状态跟踪
├── [系统目录]/                  # 安装时可自定义
│   ├── PaperForge/
│   │   ├── exports/             # Zotero JSON 导出
│   │   └── ocr/                 # OCR 结果
│   └── Zotero/                  # Junction 到 Zotero 数据目录
├── [Agent配置目录]/             # 根据平台和安装配置决定
│   └── skills/
│       └── literature-qa/
│           ├── scripts/ld_deep.py
│           ├── prompt_deep_subagent.md
│           └── chart-reading/   # 14 种图表阅读指南
├── .env                         # API Key 配置
├── paperforge.json              # 版本配置
└── AGENTS.md                    # 安装后指南

文档

核心命令

# PaperForge CLI在终端中直接运行
paperforge status            # 查看状态
paperforge sync              # 同步 Zotero 文献并生成正式笔记
paperforge ocr               # 运行 PDF OCR
paperforge deep-reading      # 查看精读队列

# Agent 命令(在 OpenCode 中使用)
/pf-deep <zotero_key>    # 完整三阶段精读(需要 AI 理解论文)
/pf-paper <zotero_key>   # 快速摘要(需要 AI 理解论文)
/pf-sync                 # 同步 ZoteroAgent 帮你检查并执行)
/pf-ocr                  # 运行 OCRAgent 帮你检查队列并执行)
/pf-status               # 查看状态Agent 帮你解读诊断结果)

双模式说明/pf-sync/pf-ocr/pf-statuspaperforge sync/ocr/status 是同一命令的两种调用方式。你可以在终端直接运行 CLI也可以在 OpenCode 中使用 /pf-* 让 Agent 帮你检查前置条件并解读输出。 python <resolved_worker_script> --vault . ocr python <resolved_worker_script> --vault . status


## License

MIT License — 允许商业使用,需保留版权声明。