cpmp

Crawl markdown corpora into a typed link graph, audit connectivity health, and explore them in a WebGL galaxy viewer.

Galaxy	Local	Audit	Search

Why cpmp?

Large doc trees drift: broken links, orphan pages, islands that never join the main hub. cpmp gives you:

1. A typed multigraph (schema v2) from real markdown links + structure + mentions
2. A deterministic audit (broken links, orphans, islands, hub stubs) and an LLM-ready brief
3. A fast Galaxy / Local / Audit viewer to navigate and triage without leaving the browser

Install

# From GitHub
cargo install --git https://github.com/QaAudio/cpmp.git

# Or from a checkout
git clone https://github.com/QaAudio/cpmp.git
cd cpmp
cargo build --release

Requires Rust 1.80+.

Quick start

# One-shot: crawl folder(s) then open the galaxy viewer
cpmp open path/to/docs

# Stepwise
cpmp crawl path/to/docs notes -o out/graph.json --timings
cpmp audit -i out/graph.json
cpmp report -i out/graph.json -o out/report --format md
cpmp view -i out/graph.json

From a cargo checkout without installing:

cargo run --release -- open tests/fixtures/mini_corpus

Subcommands: open · crawl · audit · report · view — full flags in docs/cli.md.

Views at a glance

View	Role
Galaxy	Ambient edges, hover/multi-highlight, legend layers, frustum pins, optional drag
Local	1–2 hop constellation around the focused node
Audit	Health score, severity facets, virtualized findings, Export

Keyboard: 1 Galaxy · 2 Local · 3 Audit · / search · ? help · C clear · X hide · H ambient · Esc dismiss ladder.

Deep links: ?view=audit&severity=high, ?focus=path/to.md, ?highlight=id1,id2.

More interaction detail: docs/viewer.md.

Edge kinds & audit

Edge kind	Meaning
md_link	Resolved markdown links
parent_of	Hub README / INDEX / SKILL → child
sibling	Adjacent files in the same folder
unlinked_mention	Title/slug hit without an explicit link

Audit rule	Typical severity
broken_link	high
orphan	medium (catalog-like → info)
island_member	low / medium
hub_stub	low

cpmp audit --strict fails if any high findings exist. Schema and brief fields: docs/schema.md.

.cpmpignore

gitignore-compatible excludes for crawl content (ancestors from cwd + nested under roots). See docs/ignore.md.

**/raw/
**/sandbox/
out/
target/

Documentation

Guide
Architecture	Pipeline, budgets, ceilings
Schema	Graph v2, findings, audit.brief
CLI	Every subcommand and flag
Viewer	Galaxy / Local / Audit
Ignore	.cpmpignore rules
Contributing	Build, test, e2e, screenshots

Develop

cargo test
cargo build --release

# Playwright e2e (Chrome baselines)
npm install
npx playwright install chromium
npm run test:e2e

# Refresh README / docs screenshots
npm run docs:shots

License

MIT — see CHANGELOG for release notes.