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.40.tar.gz (136.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.40-py3-none-any.whl (133.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.40.tar.gz
  • Upload date:
  • Size: 136.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.40.tar.gz
Algorithm Hash digest
SHA256 6113c01d5c3a220d0b99b8a8c95246dd9e651c9d81a1a33b80d3a41acd3a960c
MD5 fc71b00a6199c4f95644b86b06419dee
BLAKE2b-256 564df6cd458aa54aac15264455621514accd7fb288574ae92771c21a8a757254

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.40-py3-none-any.whl
Algorithm Hash digest
SHA256 150ea4a38712bb956570c44af208f9cf460af3b1fd9b28c4e122f3f696ea548e
MD5 3a505d63e5e6342a3d10f175de6de934
BLAKE2b-256 e310f389040c7538b5ce0ef396676e7c7c7ea0d01889ea8a474e61f159903e5b

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