Proseview
A local dashboard for Markdown-first novel repositories. ✍️
Proseview reads a folder of Markdown scenes and reports lexical health, pacing, character presence, and revision history. The same pages can be read, edited, and annotated in place.
Core analysis stays on your machine: no account, subscription, database, or telemetry. AI features are opt-in and run through agent CLIs you installed and logged into yourself — Codex or Claude in the side dock, and Codex, Claude, or Gemini in a terminal scoped to one file. When you use one, Proseview sends the active document by default, plus any selection or attachments, to that agent under its own login and data handling.
Proseview reads plain .md files in whatever layout they already have, so it
sits alongside Obsidian, Vim, or any other Markdown editor.
📸 Screenshots
Editorial passes
The Analysis panel lists nine prose passes, each with the number of matches in this scene. Switching a row on marks the page you are reading: repetition, filter verbs, sensory language, passive voice.
Editing
Edit turns the page you were reading into the page you type into — same
typography, same highlights. Mod-S saves to the file, and the stats update.
Agent tabs
Codex and Claude each get a tab, each with its own conversation for the document you are reading. Both keep working while the other is in front, and neither can see the other's thread.
Search
Mod-K from anywhere. File paths, scene metadata, TODOs, notes, and prose,
grouped by kind.
Timeline
Chapter proportion and words per scene, your storylines as lanes, and reading order against the order events actually happen — so a scene read far from where it happens is visible instead of inferred. Hover any scene for its card.
Character presence
Clips use the bundled demo manuscript: Alice's Adventures in Wonderland (public domain), split into 39 scenes across 12 chapters with story fields filled in. See fixtures/demo-book.
✨ Features
- 📊 Dashboard. Word count, chapter pacing, lexical health, sentence rhythm, character presence, setting stickiness, and a sortable scene table. What the numbers mean →
- 📖 Reading view and WYSIWYG editor. The same typographic page, with
Edittoggled on.Mod-Ssaves; a conflict guard checks the file mtime so a change made in your own editor is never silently overwritten. - 🎨 Editorial highlights. Nine prose passes over any scene, switched on from the Analysis panel with a match count each: repetition, passive voice, filter verbs, crutch words, hyperbole, lyrical reach, sensory density, comedy beats, first-person rate.
- 🗒️ Inline TODOs and Notes. Select a passage, drop a
TODOor a taggedNOTE, and it lands in the file as a Markdown comment. They stay in the file, so they survive in git and turn up in grep. - 🕰️ Timeline. The shape of the book, storylines as lanes, and reading order against the order events happen.
- 🤖 Two agents, side by side. Codex and Claude each get a dock tab and their own conversation per document. Both run at once; switching tabs never interrupts the other. How the AI features work →
- 🔎 Repository search.
Mod-Kfrom anywhere — paths, metadata, TODOs, notes, and prose, grouped by kind. - 🕹️ File history. Versions of a scene, restored through a diff you can read first.
- 📦 EPUB export.
proseview exportcompiles your scenes in the order the dashboard counts them. Export options → - 🔁 Live reload, deep links, themes. Save in your editor and the page follows. Every scene has a URL. Six themes, seven fonts.
- 🧪 Tested. A unit suite plus a browser tier that drives the real UI. One behaviour suite runs against both agents, so a feature cannot silently work on one tab and not the other.
🤖 Optional AI
Entirely optional, and it never runs on its own. Proseview has no model of its own and no API key of yours — it drives the agent CLIs already installed on your machine, under your login: Codex and Claude for the two Discuss tabs, and Codex, Claude, or Gemini for a terminal conversation about a single file.
Agent sessions are read-only. Anything beyond reading — a shell command, a file write — stops at an approval you have to grant, and raw model reasoning is never forwarded to the browser.
Continuity and canon questions come back with citations, and suggested edits arrive as proposals you accept or reject before anything is written.
Everything else works without an agent installed. Details →
🚀 Quick start
Requirements: Python 3.11+ on macOS, Linux, or Windows. The in-browser terminal needs a real PTY, so it is hidden on Windows; everything else works.
pipx install proseview
proseview --root /path/to/your/novel
A browser tab opens at http://localhost:7842. Press Ctrl-C to stop.
Point it at any folder of Markdown. If there is no manuscript/ directory the
whole folder is the manuscript, so an Obsidian vault or a flat pile of chapter
files works with no configuration.
my-novel/
├── manuscript/
│ ├── ch01/
│ │ ├── 01-opening.md
│ │ └── 02-meeting.md
│ └── ch02/
│ └── 01-aftermath.md
└── .proseview.yaml # optional
Frontmatter is optional. Proseview reads what is there and falls back on what is not. Layout and the full frontmatter contract →
⚙️ Configuration
Proseview runs without a config file. A .proseview.yaml at the repo root can
change where things live, set a word-count goal, pick which agent tab opens
first, or point the Timeline at your own frontmatter keys. proseview init
writes a starter file.
manuscript_path: manuscript/
target_words: 80000
discuss:
agent: codex
📚 Documentation
🛣️ Status
Proseview is alpha. Everything described above works today. Still unfinished:
- 🚧 Skills on the Claude tab. Codex discovers them today; Claude's picker is still empty.
- 🚧 Frontmatter editor (status, where, todos) inside the scene viewer so you don't need to drop into your text editor for routine fields.
See plans/roadmap.md for the full punch list.
🧪 Development
pip install -e ".[dev]"
pytest
That runs 642 unit tests plus an HTTP end-to-end tier that boots a real
proseview subprocess and drives every endpoint — saves and the conflict
guard, TODOs and notes, the AI proposal bridge through the actual CLI, live
reload over SSE, and PTY terminals — asserting on bytes written to disk.
Discuss integration tests use a deterministic fake app-server and isolated
home/state directories; they never contact Codex, the network, or your profile.
~15 seconds, no extra dependencies.
A browser tier drives the real UI in Chromium (editor round-trip fidelity, the selection menu, highlight passes, deep links, agents, terminals, Discuss streaming/approvals/shared-dock behavior, and applying an AI proposal end to end). It's opt-in:
pip install -e ".[e2e]"
python -m playwright install chromium
pytest -m e2e_browser
Both tiers work on a throwaway copy of fixtures/demo-repo. See
CONTRIBUTING.md for details.
📜 License
MIT. See LICENSE.
Release files for proseview 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| proseview-0.2.0.tar.gz | 692.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| proseview-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / proseview-0.2.0.tar.gz
| Download URL | proseview-0.2.0.tar.gz |
|---|---|
| Size | 692.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf3714f73e8a8d6d6d63611c759d508e2a242b948abfd14931d67d134378917d
|
|
BLAKE2b-256 checksum How to use checksums |
735bd860348a2e79ede85c4a08b786de393d47ba6314884aa95fbd7481e0d1b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency logRelease files / proseview-0.2.0-py3-none-any.whl
| Download URL | proseview-0.2.0-py3-none-any.whl |
|---|---|
| Size | 639.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9d1bbcdc871dcb9ac858e5cd680e1c857f666bcf91bfa75d1cc7fdc5957aea29
|
|
BLAKE2b-256 checksum How to use checksums |
becf0dc1b8bded95a94b9103f5d88b4fb5b8e1513f3baa7fa9e6febe541ddc84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency log