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.43.tar.gz (142.0 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.43-py3-none-any.whl (139.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.43.tar.gz
  • Upload date:
  • Size: 142.0 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.43.tar.gz
Algorithm Hash digest
SHA256 6e8bf641541e3c61341f8bf4861fdf90708a825aa957d456d773a107d0217f9d
MD5 5d8c2824cafa501f3602de5321098481
BLAKE2b-256 46655dd9709e8d8228d92a7c0c8512b78659935f752b9af55252d589fa603229

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.43-py3-none-any.whl
Algorithm Hash digest
SHA256 d66665e84db33f4cfb8c62da68c6a93714cd00f708500257ee2cf91de516bbcb
MD5 bc514ece47d8050526eb8883d1561049
BLAKE2b-256 09950380a528066f24fa32a6ba485afe08bbb62670919a585c93656f9521a842

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