paperflow-kit

Paperflow Kit is a local-first workspace system for research projects that are moving toward a paper. It combines the paperflow Python CLI, a versioned .paperflow/ project layer, reusable folder templates, and an AI-facing Skill so humans and assistants can work in the same structure without overwriting research material.

The kit is organized as a small monorepo:

What Paperflow Manages

Paperflow separates the visible research workspace from the local system state:

The CLI owns managed templates and update mechanics. Research content remains user-owned and is protected by template hashes, conflict candidates, and explicit promotion rules.

Quick Start

Run from the repository root without installing:

Or install the CLI package in editable mode:

Validation

Use the repository check script:

The script checks CLI import/help, Python compilation, CLI smoke tests, and the synthetic example project.

Public Repository Boundary

This repository should contain reusable system code, templates, documentation, and synthetic examples. Real paper drafts, source packages, private research notes, generated exports, and one-off build logs should stay outside the repository or be explicitly anonymized before inclusion.