# DraftPilot

DraftPilot is a local-first AI workspace for writing and managing LaTeX research papers with an Overleaf-like editing flow, local PDF compilation, SyncTeX source/PDF navigation, review highlights, rebuttal TODOs, annotations, linked local or VM codebases, and AI-agent context.

Website: https://jerrinbright.com/draftpilot/
Release manifest: https://jerrinbright.com/draftpilot/releases/manifest.json
Onboarding guide: https://jerrinbright.com/draftpilot/guides/onboarding.html
Quickstart: https://jerrinbright.com/draftpilot/guides/quickstart.html
Desktop app guide: https://jerrinbright.com/draftpilot/guides/desktop-app.html
CLI guide: https://jerrinbright.com/draftpilot/guides/cli.html
VM workflow guide: https://jerrinbright.com/draftpilot/guides/vm-workflow.html

## What DraftPilot Is

DraftPilot runs locally against real files on disk. It is designed for researchers who want paper writing, review management, rebuttal planning, and paper TODOs to stay connected to source code, figures, PDFs, experiment outputs, compile logs, and AI coding/research agents.

The public homepage is a product overview for first-time visitors. Setup, install commands, VM instructions, update behavior, LaTeX prerequisites, and storage details live in the onboarding guide and linked docs pages.

## Core Features

- Local LaTeX workspace management for project folders.
- Monaco-based source editing with autosave and external-change review.
- Local `latexmk` compilation with SyncTeX enabled.
- PDF.js preview with selectable text, page controls, zoom, fit, and source/PDF jumps.
- TeX and PDF highlights, comments, and checklist TODOs stored in paper metadata.
- Review and rebuttal workflows for tracking flagged passages, revision notes, and paper TODOs.
- Linked codebase metadata so AI agents can reason across manuscript and implementation.
- Per-project deadline tags for conference or submission planning.
- GitHub Pages landing site for public discovery.
- Standalone macOS arm64, Linux x64, and Windows x64 CLI binaries.
- Manifest-based `draftpilot update` with SHA-256 verification.
- Detailed release notes in the update manifest and terminal updater output.
- macOS desktop app DMG and Linux AppImage with Electron auto-update metadata.

## Install

macOS public CLI:

```bash
curl -L -o draftpilot-0.1.7-macos-arm64.tar.gz https://draftpilot-releases.jerriebright.workers.dev/releases/draftpilot-0.1.7-macos-arm64.tar.gz
tar -xzf draftpilot-0.1.7-macos-arm64.tar.gz
chmod +x draftpilot-macos-arm64
sudo mv draftpilot-macos-arm64 /usr/local/bin/draftpilot
draftpilot help
```

Linux public CLI:

```bash
curl -L -o draftpilot-0.1.7-linux-x64.tar.gz https://draftpilot-releases.jerriebright.workers.dev/releases/draftpilot-0.1.7-linux-x64.tar.gz
tar -xzf draftpilot-0.1.7-linux-x64.tar.gz
chmod +x draftpilot-linux-x64
sudo mv draftpilot-linux-x64 /usr/local/bin/draftpilot
draftpilot help
```

Desktop app packaging is in preview. The standalone CLI is the current public
release for macOS arm64 and Linux x64. Windows CLI support is preview-tested.

macOS Apple Silicon:

```bash
curl -fsSL https://jerrinbright.com/draftpilot/install.sh | bash
```

Linux x64:

```bash
curl -fsSL https://jerrinbright.com/draftpilot/install.sh | bash
```

Windows x64:

```powershell
powershell -ExecutionPolicy Bypass -Command "irm https://jerrinbright.com/draftpilot/install.ps1 | iex"
```

## CLI Examples

Local:

```bash
draftpilot launch --paper /path/to/latex-paper --codebase /path/to/research-code
```

## Telemetry

DraftPilot telemetry is optional and best-effort. It can send anonymous install
and CLI command events when internet is available. Users can disable it with
`DRAFTPILOT_TELEMETRY=0`.

Allowed client-side fields: anonymous install ID, event name, version, runtime,
platform, OS, architecture, command success/failure, duration, coarse error
category, timezone, locale, and safe counts/booleans. The server may derive
country, region, city, timezone, colo, and continent from Cloudflare request
metadata. Raw IP addresses, names, paper text, LaTeX source, file paths,
codebase paths, PDF content, comments, highlighted text, compile logs, SSH
hosts, Git remotes, usernames, API keys, and environment variables must not be
stored.

Remote VM:

```bash
draftpilot launch --host user@vm.example.com --paper /home/user/paper --codebase /home/user/research-code
```

Update:

```bash
draftpilot update
```

## Documentation Pages

- `/guides/onboarding.html`: one practical install-to-launch guide for choosing the paper folder, main TeX file, local/VM codebases, updates, and storage.
- `/guides/quickstart.html`: decision tree for choosing desktop app, CLI, or VM mode.
- `/guides/modes.html`: concise comparison of Local CLI, VM CLI, Desktop, and agent JSON mode.
- `/guides/desktop-app.html`: macOS and Linux app installation and local paper workflow.
- `/guides/cli.html`: standalone CLI installation, local launch, remote launch, JSON output, and update commands.
- `/guides/vm-workflow.html`: SSH/VM workflow for papers and codebases that live on remote Linux machines.
- `/guides/simgs-example.html`: concrete SimGS launch command and expected project wiring.
- `/guides/releases.html`: binary distribution, update manifest, desktop update metadata, and checksums.
- `/guides/storage.html`: where metadata, comments, TODOs, telemetry settings, logs, build files, and support bundles live.
- `/guides/troubleshooting.html`: fixes for Gatekeeper, Linux FUSE, SyncTeX, VM binaries, ports, and LaTeX failures.

## Intended Audience

ML researchers, robotics labs, systems researchers, PhD students, AI startups, and other teams writing papers while actively working with local code and experiments.

## Local-First Principle

DraftPilot is not a cloud editor. It has no accounts, no database, and no manuscript upload workflow by default. The app server binds locally and reads/writes the configured paper root.