paperless-cli documentation

A calm map of a sharp Rust CLI.

This site gathers the current repo docs into one quiet surface: how the Rust migration landed, how the CLI is shaped, how testing and parity work, and where the shipped skills fit.

Runtime Rust-first CLI, TUI, JSON, Markdown, and a built-in demo mode.
Compatibility Config, PDF helpers, and parity commands live in one documented surface.
Security Restricted config writes, sanitized downloads, and a polling reviewer.
Skills Repo-local skills ship alongside the binary and docs.

The repo now has enough surface area that raw Markdown files feel scattered. This site is the calmer reading view: one landing page, one page per current doc, and a short path into the commands and skills that matter most.

Open this site directly from the repo at site/index.html.

What is here

README The operational front door: install, commands, compatibility, and skills. Migration notes Why the repo moved to Rust and what stayed intentionally compatible. Architecture Config, API, services, TUI, render, and security as separate layers. Testing What is covered, why the transport abstraction matters, and how to extend it. CLI parity The compatibility-facing commands and flags carried by the Rust CLI. Release process The release-please flow, packaged GitHub assets, and crates.io publish path. Skills Repo-local skills for Paperless documents, local PDFs, and admin flows.

Current posture

  • The Rust binary is the default runtime and release target.
  • The TUI is the default interactive surface, with Markdown and JSON for non-interactive use.
  • --demo runs both the TUI and CLI against generic built-in fixtures for fast feedback cycles.
  • Compatibility features such as document content, tag edit, pdf read, and env-var config support are part of the documented surface.
  • Repo-local skills ship with the source tree so the tool can be used as both a CLI and an agent-facing capability bundle.

paperless-cli docs site ยท static, local, and intentionally low-friction