PaperPilot README

README проекта с github.com/KrushnaVardhanReddy/PaperPilot. Одним файлом markdown: README.md.

PaperPilot

PDF tools for your AI agent — and for you. Pure Rust. Runs locally. Files never leave your machine.

CI OpenSSF Scorecard Security Policy License: Apache 2.0 Rust 1.75+ MCP Compatible PRs Welcome

PaperPilot demo

Try it in your browser → · Download · Contributing · Roadmap

PaperPilot is a PDF and document toolkit written in Rust. The same engine runs as:

Surface Use it for
MCP server Give Codex, Claude Code, Gemini CLI, Cursor, Claude Desktop, or any MCP client instant document superpowers
CLI High-speed batch workflows and automated terminal pipelines
Browser Extension In-tab right-click actions on web/arXiv PDFs, clean article capture, and WASM toolkit
Browser (WASM) Zero-install web tools; files are processed in browser memory, nothing is uploaded
Desktop app Tauri + Svelte 5 GUI with interactive canvas, viewer, and pipeline builder
Local REST API Call it from Python, Node.js, n8n, LangChain, or LlamaIndex at localhost:7823

No Chromium, no C++ runtime, no cloud calls.


Self-Healing System Diagnostics

Verify your environment, gateway port, temp storage, and OCR models with one command:

paperpilot doctor
# PaperPilot System Diagnostics (v0.7.0)
# ==================================================
# Status:    Healthy
# [✓] Temp Directory: /tmp (writable & ephemeral cleanup verified)
# [✓] Gateway Port: 7823 available
# [✓] OCR Models: models/ocr/ppocrv4 (det.onnx, rec.onnx found)
# [✓] Disk Space: > 5 GB available

Open-WebUI integration (source builds): use the local gateway as a PDF-only Tika-compatible extraction server. See the Open-WebUI setup guide.


Quick start

1. Use it with your coding agent (MCP)

Codex, Claude Code, Kimi Code, and current Pi releases connect to the same local stdio server. See the coding agent setup guide for each client's configuration and verification steps. Builds from this source can also print ready-to-merge configuration:

paperpilot-mcp --client-config codex
# Also: claude-code, kimi-code, pi, claude-desktop, cursor

Download paperpilot-mcp from Releases, then add it to claude_desktop_config.json:

{
  "mcpServers": {
    "paperpilot": {
      "command": "/path/to/paperpilot-mcp"
    }
  }
}

Restart Claude and try: "Merge these two PDFs and compress the result."

2. Use the CLI

# Semantic Chunking for AI Agents & RAG (Spec 159)
paperpilot pdf-chunk --input contract.pdf --target-tokens 500 --overlap 50 --json

# Merge multiple documents
paperpilot merge --inputs doc1.pdf doc2.pdf --output merged.pdf

# High-efficiency compression
paperpilot compress --input in.pdf --quality 75 --output compressed.pdf

# Search pattern or keywords across document pages
paperpilot search --input in.pdf --query "Invoice" --json

# Rotate pages 1, 3–5 by 90°
paperpilot rotate --input in.pdf --pages 1,3-5 --angle 90 --output out.pdf

3. Use it in the browser & extension

4. Build from source

git clone https://github.com/KrushnaVardhanReddy/PaperPilot.git
cd PaperPilot
cargo build --release -p paperpilot-cli -p paperpilot-mcp -p paperpilot-gateway

Desktop app:

cd apps/desktop && pnpm install && pnpm tauri dev

Requires Rust 1.75+, Node.js, and pnpm.


What it can do (92 Tools Across 5 Interfaces)


Why another PDF tool?

Benchmarks

Run cargo bench --workspace to reproduce. Methodology and results: SYSTEM_BENCHMARK_REPORT.md.


Architecture

Desktop (Tauri) · CLI · REST (Axum) · MCP (stdio) · WASM (browser / edge)
                              │
                       Rust core workspace
   paperpilot-core · paperpilot-pdf · paperpilot-nlp · paperpilot-gateway
   paperpilot-mcp · paperpilot-wasm · paperpilot-storage

Embed in your own site

<script src="https://usepaperpilot.com/embed.js" data-tools="merge,compress,ocr"></script>
<div id="paperpilot-widget"></div>

Local REST API & Document Ingestion

paperpilot serve --port 7823
# Standard PDF Operations (JSON & multipart)
curl -X POST http://localhost:7823/api/v1/pdf/merge \
  -H "Content-Type: application/json" \
  -d '{"inputs": ["a.pdf", "b.pdf"], "output": "out.pdf"}'

# Open-WebUI & Tika In-Memory Ingestion (sub-5ms)
curl -X PUT http://localhost:7823/tika/text \
  -H "Content-Type: application/pdf" \
  --data-binary @sample.pdf

Interactive Swagger OpenAPI docs at http://localhost:7823/swagger-ui.

Security & Supply Chain Integrity

PaperPilot processes sensitive, proprietary, and personal documents on-device without cloud dependencies. We maintain rigorous software supply chain and security compliance:


Contributing & Community

Issues and PRs are welcome. Good first contributions: bug reports with a sample PDF, new tool requests, and docs fixes.

Special thanks to all community members and contributors recognized in CONTRIBUTORS.md.

License

Community Edition (this repo): Apache 2.0. It includes the CLI, MCP server, REST gateway, WASM engine, and desktop app.

An Enterprise Edition (SSO, RBAC, audit logs, DLP) is developed separately.

PaperPilot (KrushnaVardhanReddy/PaperPilot)

Ищем в базе…

Что это такое?PaperPilot — это набор инструментов для PDF и документов, написанный на чистом Rust. Он объединяет, разделяет, распознаёт текст (OCR), сжимает и иначе обрабатывает PDF-файлы полностью на вашем компьютере.
Это одно приложение или несколько разных инструментов?Один и тот же движок на Rust выпускается в пяти вариантах: MCP-сервер для ИИ-агентов, CLI для скриптов, сборка WASM, которая работает в браузере, настольное приложение на Tauri и Svelte и локальный REST API.
Как начать пользоваться?Можно сразу попробовать инструменты в браузере на usepaperpilot.com, без установки, скачать настольное приложение или бинарный файл MCP-сервера со страницы Releases либо собрать CLI и REST API из исходников с помощью Cargo.
Чего пока нельзя сделать?Шифрование, расшифровка, подписание, закрашивание (редактирование) данных, формы, аннотации, рендеринг, восстановление файлов, сравнение, PDF/A и нумерация Bates пока что в планах на версии v0.9 и v1.0 и не входят в текущий релиз v0.6.
Какие ИИ-агенты для программирования могут работать с ним через MCP?Он работает как локальный MCP-сервер через stdio, к которому могут подключиться Codex, Claude Code, Kimi Code, Pi, Claude Desktop, Cursor и любой другой клиент, совместимый с MCP.
Куда попадают мои документы при использовании?Никуда: ядро на Rust и сборка WASM обрабатывают файлы полностью на вашем компьютере или в памяти браузера, без загрузок на сервер и без обращений к облаку.
Чем отличаются редакции Community и Enterprise?Редакция Community в этом репозитории (CLI, MCP-сервер, REST-шлюз, движок WASM, настольное приложение) бесплатна и распространяется по лицензии Apache 2.0. Отдельно разрабатываемая редакция Enterprise добавляет для организаций SSO, RBAC, журналы аудита и DLP.
Какие операции с документами поддерживаются сейчас?В v0.6 есть организация PDF (объединение, разделение, поворот, изменение порядка, извлечение страниц, брошюра, N-up), сжатие, извлечение текста и OCR, добавление водяных знаков, проверка и удаление подписей, поиск персональных данных (PII), глубокая очистка (deep sanitize) и конвертация Excel в JSON и CSV.
Зачем автор создал ещё один инструмент для PDF?Чтобы по умолчанию сохранять приватность, рассматривать ИИ-агентов (MCP) как полноценный сценарий использования, а не как запоздалое дополнение, и использовать один движок на Rust для CLI, MCP, REST, WASM и настольного приложения, чтобы поведение везде было одинаковым.
Как работает OCR без какого-либо облачного сервиса?Он использует реализацию PaddleOCR на чистом Rust через крейт rten, поэтому распознавание текста на отсканированных страницах выполняется локально, без внешних API.
Какие есть похожие проекты?pdfcraft, liteparse, xerj, graphicle, leviathan, wordcraft, effectcraft, lean-ctx
Размер
84.4 MB
Звёзды
787
Возраст
1 мес
Коммиты · 90 дней