Skip to main content

Local PDF review with browser UI and Acrobat-compatible highlights

Project description

PeerFold

Website: vincenzoml.github.io/PeerFold · Source: github.com/vincenzoml/PeerFold

Review PDFs in a native window. Click, type, done.

Saved reviews: manuscript_VC-2026-06-09.pdf next to the original.

Install

macOS & Linux

curl -fsSL https://vincenzoml.github.io/PeerFold/install.sh | bash

Windows (PowerShell)

irm https://vincenzoml.github.io/PeerFold/install.ps1 | iex

Python 3.10+

python3 -m pip install --user peerfold-review
peerfold manuscript.pdf --reviewer RB

Over SSH: peerfold paper.pdf --web

Shared folder or git repo

One launcher file — pinned PyPI version, same build for every co-author. Do not submodule PeerFold.

One-liner (from project root):

curl -fsSLO https://vincenzoml.github.io/PeerFold/peerfold.py && chmod +x peerfold.py
./peerfold.py your-paper.pdf --reviewer AB

Or download peerfold.py into your project root. Packages are cached in ~/.local/share/peerfold/cache (uv; override with PEERFOLD_CACHE / PEERFOLD_DATA).

Upgrade when needed:

./peerfold.py --update   # then commit peerfold.py

Site: vincenzoml.github.io/PeerFold

Usage

peerfold paper.pdf                  # native window (default)
peerfold paper.pdf -r VC            # reviewer short name
peerfold paper.pdf --web            # system browser (SSH)
peerfold paper.pdf --no-browser     # server only

Environment: PEERFOLD_REVIEWER sets the default reviewer name. Set PEERFOLD_SAVE_COPY=1 to write sidecar files (paper_VC-2026-06-09.pdf) instead of editing in place.

Roadmap

Planned features (discussion and design in GitHub issues):

Feature Issue
Merge comments from different PDFs into one view #1
PDF diff view for revised manuscripts #2
GitHub integration for paper repos and review versioning #3
Export comments to human-readable text (page, section, quote) #4

Development

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
peerfold sample.pdf
pytest

License

MIT — see LICENSE. Uses PyMuPDF (AGPL).

Brought to you by vincenzoml@gmail.com · vincenzoml.github.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peerfold_review-0.1.42.tar.gz (140.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

peerfold_review-0.1.42-py3-none-any.whl (137.6 kB view details)

Uploaded Python 3

File details

Details for the file peerfold_review-0.1.42.tar.gz.

File metadata

  • Download URL: peerfold_review-0.1.42.tar.gz
  • Upload date:
  • Size: 140.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for peerfold_review-0.1.42.tar.gz
Algorithm Hash digest
SHA256 bd643e9d65dce77a44034e58b601a9da4196eaaa5aba92d0eb02f0ae90c538f5
MD5 3ae849dd4c6809c5dad0bee80751feb0
BLAKE2b-256 4ae47d15f5f1a1f04119ae48ae860f6b334ac284aa45ede86196d64d37687baa

See more details on using hashes here.

File details

Details for the file peerfold_review-0.1.42-py3-none-any.whl.

File metadata

File hashes

Hashes for peerfold_review-0.1.42-py3-none-any.whl
Algorithm Hash digest
SHA256 264647aae6a1f6f1b6718ac917db7e86bb39eda36436312e53f0fce2d40ef9eb
MD5 2ddea7bcd019c35cdf1881a87e6f6acb
BLAKE2b-256 f8e80501fbb4728f958a09e578e2cae8a92e913e85a5f8ca6bc33e5d7cf4b502

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page