Skip to main content

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"   # standalone CLI on PATH, or
pip install "repoglyph"       # CLI in the active environment; add the [png] extra for PNG output

Each installs the repoglyph command. Python 3.12+.

Usage

Agent Usage

A usage skill for repoglyph itself can be installed via npx skills, plugin marketplace, or found in this repo (plugin/skills/repoglyph)

npx skills add remsky/repoglyph-py

OR

claude plugin marketplace add remsky/repoglyph-py
claude plugin install repoglyph@repoglyph
CLI Usage

Basic 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
--svg / --no-svg on for a banner, off with --okf/--skill write the SVG
--png / --no-png on for a banner, off with --okf/--skill write the PNG (needs the png extra)
--skip-commons off drop lockfiles from the city
--staged off draw HEAD + staged changes
--okf [DIR] off write an OKF context bundle
--skill [DIR] off skill-compliant OKF bundle (default .claude/skills/repo-map)
--inventory off add per-district docs with full file listings to the 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 / Skill Generation

--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 a per-district stats table (files, bytes, depth, churn, largest file). That's a flat handful of documents by default; --inventory adds one document per district with its full file listing. A reader working in a checkout can list files itself, so the default bundle carries only what a listing can't show. In bundle mode no banner is drawn; add --svg or --png if you also want the image.

See it live: the glyph branch holds the bundle for this repo, regenerated by CI on every push to main.

repoglyph . --okf

Or shortcut with --skill to generate with skill-compliant filenames and frontmatter, so an agent can quickly get its bearings on any repo.

repoglyph . --skill # -> .claude/skills/repo-map 
repoglyph . --skill <custom output path>
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.

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.3.0.tar.gz (100.7 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.3.0-py3-none-any.whl (118.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: repoglyph-0.3.0.tar.gz
  • Upload date:
  • Size: 100.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.3.0.tar.gz
Algorithm Hash digest
SHA256 69f0bc2ff5a8fbf9ee86522ffc3e363d2dd120d2e8acec2253ea9d23e92c5326
MD5 1d4ccb8127b36ec9787d97802d59cb92
BLAKE2b-256 5533dd70bc699c9f72a34cc0d1dc89d95b69cc7c97ebec4fd2316ebfe54f8921

See more details on using hashes here.

File details

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

File metadata

  • Download URL: repoglyph-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 118.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ca32d385cb2d9fc6e80d046607636a8206140df8f104c10eb36341b4471b9a4
MD5 da2438032aa82dfb743b074b7e82c058
BLAKE2b-256 fcfaf436792113c97db5ad9b824189f2b9408717075b7d13d655e32ddb07381c

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.0

2 files

0.1.0

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page