Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PaperForge banner

PaperForge

Version Python License

简体中文 · English

铸知识为器,启洞见之明。 — Forge Knowledge, Empower Insight.

PaperForge brings your Zotero library into Obsidian. Sync papers, run OCR, extract figures, and do AI-assisted deep reading — all inside a single vault.


0. What PaperForge Is

PaperForge is not just an Obsidian plugin. It has two parts:

Part What Does Where
Obsidian Plugin main.js + manifest.json + styles.css Dashboard, buttons, settings UI .obsidian/plugins/paperforge/ in your vault
Python Package paperforge Sync, OCR, Doctor, repair Your system Python (pip install)

The plugin is the interface. The Python package is the engine. Every button you click in the plugin actually runs a Python command behind the scenes.

After installing the plugin, you MUST verify that the Python package is also installed and version-matched.


1. Install the Obsidian Plugin

Option A: Community Plugin Browser (Recommended)

  1. Open Obsidian → Settings → Community plugins → Browse
  2. Search for PaperForge
  3. Click Install, then Enable

Community plugins auto-update through Obsidian. No extra steps needed.

Option B: BRAT

If you need beta versions or the plugin hasn't appeared in search yet:

  1. Install BRAT from the Obsidian community plugin browser
  2. Open BRAT settings → Add Beta Plugin
  3. Enter: https://github.com/LLLin000/PaperForge
  4. Enable PaperForge in Settings → Community Plugins

Option C: Manual Download

  1. Go to Releases
  2. Download the three files: main.js, manifest.json, styles.css
  3. Create .obsidian/plugins/paperforge/ in your vault
  4. Put the three files there
  5. Restart Obsidian → Settings → Community Plugins → enable PaperForge

Manual install does not auto-update. You'll need to re-download for each new version.


2. Install the Python Package

After enabling the plugin, open the PaperForge settings tab. You'll see a Runtime Status section:

Plugin v1.5.0 → Python Package v1.5.0 ✓ Matched
  • If it says "Not installed" → click Open Wizard to re-run the setup process
  • If it says "Mismatch" → the Python package auto-updates when the plugin updates. If it didn't succeed, click Update Runtime to manually trigger

3. Quickstart

# 1. Export from Zotero (Better BibTeX JSON, Keep updated) to exports/
# 2. Sync
paperforge sync

# 3. Mark a paper for OCR in its frontmatter: do_ocr: true
# 4. Run OCR
paperforge ocr

# 5. Mark for deep reading: analyze: true
# 6. In your Agent chat:
/pf-deep <zotero_key>

文档导航

你想做什么 去看
完整教程,从安装到精读 使用教程
遇到问题了 故障排除
查某个命令 命令参考
如何升级 更新指南
架构 / 维护 / 发布 架构文档
AI Agent 协作 AGENTS.md

License

CC BY-NC-SA 4.0. Non-commercial use only.

Acknowledgments

Built on PaddleOCR, Obsidian, Better BibTeX for Zotero, and other great open-source projects.

Metadata

Release files for paperforge 2.0.0rc3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paperforge 2.0.0rc3
File Size Uploaded
paperforge-2.0.0rc3.tar.gz 1.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for paperforge 2.0.0rc3
File Interpreter ABI Platform
paperforge-2.0.0rc3-py3-none-any.whl Python 3 none any Details

Total release size: 2.8 MB

Release files / paperforge-2.0.0rc3.tar.gz

Download URL paperforge-2.0.0rc3.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
1de5c32d26d5bd102221b0b6659dbe569c3f107f7dc453faabe3593e7c5cf5f6
BLAKE2b-256 checksum
How to use checksums
20757c9e5298782cdb07224908f7bcefad5284723b8c7832c60cfa91767fd41f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / paperforge-2.0.0rc3-py3-none-any.whl

Download URL paperforge-2.0.0rc3-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
2bfb16e82e6359336d8b2f1a043ca351830c64f3075f0508037f8352659b73c4
BLAKE2b-256 checksum
How to use checksums
44a1caca2e309145d22d6ab4ab198027aa263b6617647e33f8968397d0035575
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

2.0.0rc3 This release

2 release files

1.5.14

2 release files

1.5.13

2 release files

1.5.12

2 release files

1.5.11

2 release files

1.5.10

2 release files

1.5.9

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page