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.44.tar.gz (148.9 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.44-py3-none-any.whl (145.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peerfold_review-0.1.44.tar.gz
  • Upload date:
  • Size: 148.9 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.44.tar.gz
Algorithm Hash digest
SHA256 fabed5996f6a81b7b06c67c767224337f9a69470fc20a301a60fd9cb0daa5207
MD5 a782f0faee3b799e9332f84c3da841d7
BLAKE2b-256 3bcf096d5cc532119fc7b625641427c7b1ef006411fb009796ae6f262e7a0878

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peerfold_review-0.1.44-py3-none-any.whl
Algorithm Hash digest
SHA256 0275eb8fb12c80648714a65477f07202829094ee6617a28882a31111f0da81c8
MD5 de993b5582c83ce7716f5b503226097e
BLAKE2b-256 63931ea54930e42cfca8ef962321e596efb20ef25335f831e89cc1192aa50703

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