obsidian-plugin/lllin000_PaperForge
1
0
Fork 0
mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 06:50:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
lllin000_PaperForge/INSTALLATION.md
Research Assistant bbd39a90d3 v1.4.17rc4 
Milestone v2.1: Contract-Driven Architecture & Engineering Hardening

- Stop the Bleeding: version sync checker, PyYAML hardening, install docs unification
- Contract Layer: PFResult/PFError dataclasses, ErrorCode enum, --json wrapping
- Service Extraction: sync.py decomposed into 3 adapters + SyncService
- State Machine: PdfStatus/OcrStatus/Lifecycle enums, transitions, field registry
- Setup Modularization: setup_wizard.py decomposed into 6 classes

173 tests passing, 0 regressions.
2026-05-09 17:05:07 +08:00

1.8 KiB
Raw Blame History

PaperForge Installation Guide

Canonical install reference. For other docs, see README.md.

Method 1: Obsidian Plugin (Recommended)

  1. Download the plugin files from the latest release.
  2. Extract and copy the files into vault/.obsidian/plugins/paperforge/.
  3. Open Obsidian -> Settings -> Community Plugins -> Enable PaperForge.
  4. Open PaperForge settings and click Open Installation Wizard.
  5. Follow the 5-step guided setup: Overview -> Directory Config -> Agent & Keys -> Install -> Done.

The wizard auto-detects Python, Zotero, and Better BibTeX before installation starts.

Method 2: CLI via pip (Developers)

pip install git+https://github.com/LLLin000/PaperForge.git

Then run the headless setup:

python -m paperforge setup --headless --agent opencode --paddleocr-key <key>

For the latest stable release, replace master with a version tag:

pip install git+https://github.com/LLLin000/PaperForge.git@v1.4.17rc3

Method 3: AI Agent Setup

Copy the following to your AI agent for a guided headless install:

Prerequisites

Software Purpose Get it
Python 3.10+ Run PaperForge CLI and backend tasks https://python.org
Zotero Literature management https://zotero.org
Better BibTeX Auto-export metadata as JSON https://retorque.re/zotero-better-bibtex/
PaddleOCR Key OCR text and layout extraction https://aistudio.baidu.com/paddleocr

Post-Installation

After installing, see AGENTS.md for first-use workflow and detailed command reference.