Skip to main content

A spooky utility for data mining git repositories (and any folder foolish enough to hold still).

Project description

git-reaper

A spooky utility for data mining git repositories (and any folder foolish enough to hold still).

git-reaper reaps structured knowledge from repositories: it clones, gathers, concatenates, and packs the contents of a git repo (or a plain directory) into clean, portable artifacts. Library first; the CLI is a thin adapter over git_reaper.core.

Install

uv tool install git-reaper   # or: pip install git-reaper

Both reaper and git-reaper land on your PATH (the long form is the fallback if the REAPER DAW already owns the short one).

Commands

Reaping and packing

Command What it does
harvest Gather files matching a pattern (default *.md) from a path or repo URL and concatenate them into one artifact with a provenance header and per-file dividers.
tree Hierarchical file listing as markdown or JSON. Depth limits, dirs-only, sizes, line counts, ignore rules.
conjure Bundle a repo into a single LLM-ingestible file: tree first, then every text file inlined with spec'd delimiters. --sha256 for verifiable hashes, --split-tokens N to shard into context-window-sized parts.
reanimate The inverse of conjure: reconstruct a directory tree from a packed artifact. --verify checks per-file hashes; path traversal is refused outright.
census File-type census: counts, sizes, line counts, language breakdown, token estimate. Size a repo before packing it.
unfinished Scan for TODO / FIXME / HACK / XXX markers, with authors via git blame and --age for how long each has haunted.
grimoire Show effective configuration, where each value came from, and stored recipes.
cast Run a saved recipe from the grimoire instead of retyping nine flags.
pulse Signs-of-life check: git present, optional extras, cache health.
banish Clear the catacombs (the clone cache). --older-than 7d for partial exorcisms.
summon Launch the interactive Textual TUI (needs the [tui] extra): pick a source and a ritual, watch it reap, preview the artifact, and save it.

Git necromancy (history mining)

Command What it does
chronicle Commit history (SHA, author, date, message, churn) to markdown, JSON, or CSV. --changelog groups commits by tag.
souls Contributor stats: commits, lines added/removed, first/last seen, bus factor. --heatmap draws a day-of-week x hour activity grid and flags the repo's witching hour.
haunt Code churn and hotspots: files ranked by change frequency and churn, the classic bug-risk proxy.
autopsy <path> Deep single-file exam: creation commit, rename history (--follow), authors over time, churn, and a blame-based line-age summary.
graveyard Every file that ever lived and died: path, date of death, the fatal commit, and its author.
resurrect <path> Restore a dead file's last living bytes into the working tree or --out. Path traversal is refused outright.
ghosts Branch hygiene: branches ranked by abandonment, with merged, gone-upstream, and (past --than 90d) stale flags.
rot Staleness report: surviving files ranked by how long they have gone untouched.
tombstone A stats card for demos and READMEs (born, age, commits, souls, last words, witching hour) as ASCII tombstone art, or JSON.

History commands need real history, so remote sources are cloned full-depth (a previously shallow catacombs clone is unshallowed automatically).

reaper harvest https://github.com/Textualize/rich --pattern "*.md" -o RICH.md
reaper conjure . --sha256 --split-tokens 100000 -o PACKED.md
reaper reanimate PACKED.md --out risen/ --verify
reaper census . --format csv | head
reaper unfinished . --age
reaper cast nightly-pack
reaper tree . --format json | jq .file_count
reaper banish --older-than 7d

reaper chronicle . --changelog
reaper souls . --heatmap
reaper haunt . -n 20 --format json | jq '.hotspots[0]'
reaper autopsy src/git_reaper/cli.py
reaper graveyard . && reaper resurrect old/module.py --out risen/
reaper ghosts . --than 90d
reaper tombstone .

reaper summon .            # interactive TUI (pip install "git-reaper[tui]")

Recipes live in .reaperrc (or [tool.reaper] in pyproject.toml):

[recipes.nightly-pack]
command = "conjure"
args = [".", "--sha256", "--split-tokens", "100000", "--out", "PACKED.md"]
description = "the whole crypt, sharded for the model"

Behavior you can rely on

  • Artifacts to stdout (or --out); narration to stderr. Piping is always safe.
  • Deterministic output. Same repo state + same flags = byte-identical artifact (only the provenance timestamp moves).
  • Provenance by default. Every artifact opens with source, ref/sha, timestamp, tool version, and the exact invocation.
  • Ignore rules honored. .gitignore + .reaperignore + --exclude globs; .git is never reaped.
  • Caps with receipts. Size caps and binary detection skip files loudly, never silently.
  • The catacombs. Remote clones cache under ~/.cache/git-reaper/catacombs/<host>/<owner>/<repo>, shallow, reused across runs. Local file:// sources are buried flat (localhost/<name>-<digest>) to stay inside Windows path limits.
  • Published schemas. Every JSON-emitting command prints its JSON schema with --schema.
  • --plain / NO_COLOR produce clean ASCII; non-tty output auto-disables the theatrics.
  • No telemetry. The dead tell no tales.

Library use

from git_reaper.core.source import resolve_source
from git_reaper.core.harvest import harvest
from git_reaper.formatters.markdown import write_harvest

repo = resolve_source("https://github.com/Textualize/rich").repo
result = harvest(repo, patterns=("*.md",))
with open("RICH.md", "w") as fh:
    write_harvest(result, fh)

Development

Everything runs through uv and the Makefile:

make setup      # create venv, install deps
make check      # lint + typecheck + tests (the full gauntlet)
make fmt        # auto-format and fix lint findings
make test       # pytest
make cov        # pytest with coverage
make docs       # serve the docs locally
make run ARGS="tree ."
make build      # sdist + wheel

License

MIT. Rest in peace.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git_reaper-0.4.0.tar.gz (167.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

git_reaper-0.4.0-py3-none-any.whl (66.4 kB view details)

Uploaded Python 3

File details

Details for the file git_reaper-0.4.0.tar.gz.

File metadata

  • Download URL: git_reaper-0.4.0.tar.gz
  • Upload date:
  • Size: 167.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for git_reaper-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4570fab7dc621fb1aed4382f57a9e580129b38106caf40097005b6eeb7e5d698
MD5 25ad1b28b16417dca06798fb207bc2bd
BLAKE2b-256 44a3ac8ddf03e0e78b8d099cf827348d533ddc2c97980d66988164b8d6e1ff8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_reaper-0.4.0.tar.gz:

Publisher: publish.yml on jmcmeen/git-reaper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file git_reaper-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: git_reaper-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 66.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for git_reaper-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d70a27b34c383b142aef850184f36ab88d30ae058bda8ccaec2010ff1506842c
MD5 9c7a3e2c95ed1bf323dbb1ffa560ea1b
BLAKE2b-256 418a0d14d42480d0044d80260b02e3ddb9065df3daa9d5916da268ab6c252d41

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_reaper-0.4.0-py3-none-any.whl:

Publisher: publish.yml on jmcmeen/git-reaper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page