Skip to content

About

An agent skill that turns a repository into an interactive factory-floor map: services as factories, calls as belts, events as drones, etc. Every connection traced to its file and line.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

codebase-map

Turn a repository into a map you can walk through: its services, the calls between them, events, streams and database reads and writes, drawn as a factory floor of buildings and belts.

Open the demo · Read the field guide · Install

codebase-map is an agent skill. You ask your coding agent to map a repository, it reads the code, and you get an interactive page you can open in any browser. It works with Claude Code, GitHub Copilot, Cursor, Codex, Antigravity CLI and any other agent that reads Agent Skills.

The whole system on one floor

See the whole system. Services are buildings, databases a bus along the bottom; belts, pipes, drones and rails are requests, streams, events and batch jobs.

A selected service and its connections

Click anything. Every connection names the file and line it comes from, and whether it was seen or inferred.

A trace of one service

Follow the data. Trace any box upstream or downstream to the methods, tables, topics and services it reaches, with example requests.

Inside a service

Go inside. Open a service to see its packages, classes and methods on floors of their own.

Keep it current. A map records the commit it was made from, and asking again rescans only what changed. Comments and pins you leave in the viewer go back to the agent on the next run.

Install

Claude Code

/plugin marketplace add si1verwind17/codebase-map
/plugin install codebase-map@codebase-map

GitHub Copilot, Cursor, Codex, Antigravity CLI and others, via GitHub CLI:

gh skill install si1verwind17/codebase-map

Anything else: copy skills/visualizing-codebases/ into your agent's skills folder.

You need Python 3.10 or later and git. Node 18 or later is optional: with it, each run also checks the drawing.

Use

In the repository you want mapped, run the skill by name:

/codebase-map:visualizing-codebases

That is its name when installed as the Claude Code plugin; copied into a skills folder it is /visualizing-codebases. Or just ask your agent in plain words:

Map this repository.

Later, run it again, or ask:

Refresh the code map for the latest commit.

The map lands in docs/viz-code/, and nothing outside it is touched. Open docs/viz-code/index.html, and commit code-map.json, stack.yaml, README.md, .gitignore and .gitattributes from that folder; the rest are working files, already gitignored.

Found something it gets wrong? Run the skill with send-feedback (/codebase-map:visualizing-codebases send-feedback), or ask your agent to send feedback on the code map. It drafts an issue for this repository with your code's names left out, shows you the exact text, and opens GitHub's form; you read it and submit it yourself. Or open an issue directly.

Languages: Scala, Python, Java, Kotlin, TypeScript, JavaScript, Go, C#, Rust, Ruby and PHP. A generic reader maps classes, methods, calls and imports in any of them, whatever the framework. Common frameworks' routes and libraries are known out of the box (Spring, NestJS, Express, FastAPI, Rails, Laravel, ASP.NET, Axum and more); for any other, the agent works them out from your code and records them in a stack.yaml next to the map.

Development

How the repo is laid out and how to build and test it: DEVELOPMENT.md.

License

MIT

About

An agent skill that turns a repository into an interactive factory-floor map: services as factories, calls as belts, events as drones, etc. Every connection traced to its file and line.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages