Skip to main content

Generate an isometric city-skyline fingerprint banner (SVG) from a local git repository.

Project description

repoglyph

OKF

tests coverage

repoglyph banner

+Open Knowledge Format bundle generator showing repo churn, file change coupling, and structural fingerprint.

+Isometric repo-city banners from local git clone.

(Offline port of repoglyph.net; hosted (free) customization explorer and web-cached banners there.)

Install

uv tool install "repoglyph[png]"   # standalone CLI on PATH
pip install "repoglyph[png]"       # CLI in the active environment
uv add --dev "repoglyph[png]"      # project dev dependency (CI, hooks)

Each installs the repoglyph command. Python 3.12+. Drop the png extra for SVG-only output.

Usage

repoglyph                 # current repo w/ defaults
repoglyph ../project
repoglyph . --style skyline --palette neon

Writes <repo>/.glyph/<owner>_<repo>_<style>.svg, plus a PNG with the png extra.

All flags
Flag Default Meaning
--commits N 50 commits used for lit windows
--style NAME oblique oblique, skyline, or highrise
--palette NAME|FILE light built-in theme or palette JSON
--size WxH 1280x480 canvas size
--full off fit canvas to the whole city
--out FILE auto output SVG path
--out-dir DIR <repo>/.glyph folder for all outputs
--no-png off skip PNG output
--skip-commons off drop lockfiles from the city
--staged off draw HEAD + staged changes
--okf [DIR] off write an OKF context bundle
--skill off add a SKILL.md to the OKF bundle
--cache off save repo data for --from-cache

repoglyph --help for the rest.

Styles
  • oblique: flat cabinet-oblique map (default)
  • skyline: one building per file
  • highrise: one tower per district, floors are subdirs

OKF

--okf writes markdown context files from the same repo data: an index, a repository summary, hotspots (churn ranking plus change-coupling hubs mined from commit history), and one file per district.

Add --skill and point it at a skills folder to ship the bundle as a self-updating map-of-the-codebase agent skill:

repoglyph . --okf .claude/skills/repo-map --skill

This repo

claude plugin marketplace add remsky/repoglyph-py
claude plugin install repoglyph@repoglyph
Limits
  • Shows folder structure, not runtime architecture.
  • Lit windows and coupling use the sampled commit window, not full history.
  • File bytes proxy size.

Contributing

See CONTRIBUTING.md.

License

Apache-2.0. Bundled Monaspace Xenon fonts are SIL OFL.

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

repoglyph-0.2.0.tar.gz (99.0 kB view details)

Uploaded Source

Built Distribution

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

repoglyph-0.2.0-py3-none-any.whl (116.7 kB view details)

Uploaded Python 3

File details

Details for the file repoglyph-0.2.0.tar.gz.

File metadata

  • Download URL: repoglyph-0.2.0.tar.gz
  • Upload date:
  • Size: 99.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for repoglyph-0.2.0.tar.gz
Algorithm Hash digest
SHA256 27a7ee67448a2400e30cc8a37dfaa46b20b7ac0d0293958028eb7ff970e37028
MD5 07e62d0dc0b6f411fccd36937f638fd5
BLAKE2b-256 83b75bbd620240f11a87dbbf19a2c914d73aab4712194a2a8d01538abacee453

See more details on using hashes here.

File details

Details for the file repoglyph-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: repoglyph-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 116.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for repoglyph-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 099a62af5f0cf6d46f65c83af94bd0402dcf35f1425b50781d4fb267ff5dc685
MD5 b7f2d34b3e96f7073b3f8eba22917a0f
BLAKE2b-256 3e3b0d1dd955073a238c38f1236c733c5ba6bee9979b91a3bc123c2cac2b44be

See more details on using hashes here.

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