Go from install to paper workspace.

Use this page when you want the practical path: install DraftPilot, choose your paper folder, choose the main TeX file, attach codebases, and open a local browser workspace.

1. Install DraftPilot

The CLI is the easiest public path because it works for local projects, remote Linux VMs, and agent-driven workflows.

macOS and Linux

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

Windows preview

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

The installer downloads the platform binary, verifies checksums, installs into the user DraftPilot bin directory, and prints launch examples.

2. Install LaTeX tools

DraftPilot runs your local compiler. It does not bundle a full TeX distribution, so each machine that compiles a paper needs latexmk and SyncTeX-capable TeX tools.

macOSbrew install --cask mactex-no-gui, then open a new terminal or run eval "$(/usr/libexec/path_helper)".

Ubuntu/Debiansudo apt update then sudo apt install latexmk texlive-latex-extra texlive-fonts-recommended texlive-science.

Fedorasudo dnf install latexmk texlive-scheme-medium.

WindowsInstall MiKTeX or TeX Live, then make sure latexmk and synctex are available in PowerShell.

draftpilot doctor --paper /path/to/paper

3. Choose the workspace

A DraftPilot workspace starts from a paper folder. During setup, choose the main TeX file for compilation. main.tex is only the default, not a requirement.

Paper folderThe directory containing TeX, figures, bibliography files, supplements, slides, posters, and generated build outputs.

Main TeXThe root file used for the main paper build, such as main.tex, paper.tex, or submission.tex.

CodebasesOne or more local or remote repositories linked as context for AI agents and research review.

4. Launch a local project

draftpilot launch \
  --paper /path/to/latex-paper \
  --main-tex main.tex \
  --codebase /path/to/research-code \
  --open

Use a different port when you want multiple papers open at the same time.

draftpilot launch --paper ./paper-a --port 4180 --open
draftpilot launch --paper ./paper-b --port 4181 --open

5. Launch a VM-backed project

Install DraftPilot locally and on the VM. The VM binary runs beside the remote paper and codebase, while your laptop opens the local tunnel link.

draftpilot launch \
  --host user@vm.example.com \
  --paper /home/user/paper \
  --main-tex main.tex \
  --codebase /home/user/research-code \
  --open

Read the VM workflow guide

6. Use it with Codex or another agent

Agents should use JSON mode when they need stable machine-readable output.

draftpilot launch --paper ./paper --codebase ./repo --json
draftpilot doctor --paper ./paper --json
draftpilot logs --tail 120 --json

Inside the web UI, the Paper Agent panel can inspect comments, logs, TeX files, linked codebases, and build failures without leaving the workspace.

7. Update DraftPilot

draftpilot update
draftpilot version

The updater reads the release manifest, verifies the downloaded binary, replaces the local CLI, and prints a detailed "What's new" summary.

Release notes and downloads

8. Know what stays local

Your paper, code, PDFs, comments, highlights, TODOs, logs, and build files stay on the machine where the workspace runs. DraftPilot metadata is written beside the paper or under the user DraftPilot config directory.

What gets stored where? Troubleshooting