Repo Snapshot

Repo Snapshot is a tiny CLI that summarizes a codebase into a structured JSON snapshot. It is designed for agents (and humans) who need a fast, reliable orientation to an unfamiliar repository.

What It Captures

File and directory counts plus total size
Language distribution by file extension
Dependencies from package.json, requirements.txt, pyproject.toml, and go.mod
Basic test indicators (common directories and config files)
Entry points (Node main/bin, Python __main__.py)
Git branch and commit (if available)

Usage

./repo_snapshot.py /path/to/repo

Options:

--max-files (default: 2000)
--max-depth (default: 6)

Example

./repo_snapshot.py . --max-files 500 --max-depth 4

Output

The tool prints JSON to stdout. A typical output includes:

root
generated_at
stats
languages
dependencies
tests
entry_points
git

License

MIT

952 B Raw Permalink Blame History