Show HN: Instantly visualize any codebase as an interactive diagram

[ahmedkhaleel]

GitDiagram is an open-source micro dev-tool that I made this past week

Given any public GitHub repository it generates diagrams in Mermaid.js with Claude 3.5 Sonnet

I extract information from the file tree and README for details and interactivity (you can click components to be taken to relevant files and directories)

Also, you can replace "hub" with "diagram" in any repository URL to access its diagram

I created this because I wanted to contribute to open-source projects but quickly realized their codebases are too massive for me to dig through manually, so this helps me get started

I do still plan on adding other features like private repository access if that becomes a thing people want

This project was heavily inspired by https://gitingest.com/ so make sure to check that out as well!

Hopefully this tool can help you and feedback is always welcome!

[corysama]

To save everyone a lot of time and OP some money, here is https://github.com/id-Software/Quake-III-Arena diagrammed:

https://gitdiagram.com/id-Software/Quake-III-Arena

https://imgur.com/a/gwoabtk

Clicking on any box takes you directly to either a file or a folder in the repo. AFAICT, the boxes, wires, groups, labels are all inferred by the AI.

[ahmedkhaleel]

yup, if you look at the backend its basically just a pipeline of information extracted from the file tree and readme using Claude 3.5 Sonnet, sick diagram tho

[ComputerGuru]

Bug: url checker is case sensitive. For those of us that type out the url from memory on a stupid touch-type device with auto incorrect, you’ll get things like Http(s)://Github

Also might want to coalesce https and http

Not sure if it queues jobs for processing so that when I refresh after a failure it is continuing where it left off or if it is starting over anew? “Progress bar” makes it hard to say.

Aside: I dislike the “modern progress bar” that’s just a scrolling marquee of pithy quips. One of the difficult problems I worked on for a SW project was adding sane progress to a multi-stage backup tool so that the completed percentage and ETA correctly represented a mix of millions of single kb files and random multi-gb files, backed up across multiple pipelines on multiple cores, asynchronously piping from one stage to the next with buffering. Needed to add a good progress metric without poisoning cpu core caches or hurting the efficiency of how work was being divided. This doesn’t seem as hard by comparison!

Sorry for only having tangentially relevant things to report at this time; still waiting for it to finish with the fish-shell codebase so I can give some good feedback!

[layer8]

It’s also unclear why you have to enter the prefix https://github.com in the first place.

[uncomplexity_]

Of course I have to test it with https://gitdiagram.com/torvalds/linux

"Estimated cost: $8.07 USD" lol

Edit: "Repository is too large (>200k tokens) for analysis. Claude 3.5 Sonnet's max context length is 200k tokens. Current size: 1334798 tokens."

[mshockwave]

> Of course I have to test it with https://gitdiagram.com/torvalds/linux

I really wish to see how well (or bad) it works on mega projects. Because those are usually the ones I need diagrams like this the most.

[freakynit]

Same lol... my immediate test case for this was this repo...

""" Repository is too large (>200k tokens) for analysis. Claude 3.5 Sonnet's max context length is 200k tokens. Current size: 1334798 tokens. """

[mazambazz]

Same for https://gitdiagram.com/nixos/nixpkgs @ 1208750 tokens, haha.

[btown]

I really, really like this approach! Rather than trying to build a full graph of related low-level components from function calls etc., which is almost always overwhelming, this just finds the "vibes" of how modules are named in the filesystem, and how they relate to common design patterns - which in many cases is exactly what you want for exploring a codebase or understanding the scope of its offering.

https://github.com/ahmedkhaleel2004/gitdiagram/blob/main/bac... - the prompts in question. Don't sell yourself short as per the comments, they're very well designed prompts!

Using an inexpensive LLM to summarize each file might be an interesting next step, putting few-word summaries alongside the filenames in much the same setup you currently have! But, honestly, it may not be particularly necessary for large existing open-source projects that have already bikeshedded their file naming over many iterations, and/or have highly intentional structures for maintainability.

[billyp-rva]

Didn't get a response (expected), but I would caution everyone to keep expectations low. Generating system diagrams from code is extremely difficult, if not impossible, even with AI [0].

[0] https://www.ilograph.com/blog/posts/diagrams-ai-can-and-cann...

[mulmboy]

This is a poor quality blog. They "upload" source code to chatgpt so who knows if it's in context or ragd plus it looks like they reuse the chat from a previous prose -> code session. They criticise LLM for high level diagram despite using a garbage prompt and rejecting the idea of iterating on the diagram.

Anecdotally I've had great success with code to diagram via LLM including fine details. But as with anything LLM you need to really get the context right. This can not be overemphasized. And iterate with the LLM, goodness.

[lor_louis]

I tried it on a personal repo and it never ended up generating a diagram.

Might be a bug, so here's the repo. https://github.com/lorlouis/cedit

[ahmedkhaleel]

i see a diagram there now, might've taken a while to load https://gitdiagram.com/lorlouis/cedit

[antonpirker]

This looks really nice!

I tried it with mine: https://gitdiagram.com/getsentry/sentry-python

A view things:

There are way more integrations in the integration layer, so maybe they should be either shown or a "..." somewhere should tell people that there is more.

The "Hub" is deprecated so it would be cool, that this fact is shown somewhere.

Otherwise really cool!

[Animats]

Nice.

I put in a repository of mine that implements a UI in Rust, and it gave me a reasonable diagram. It's just a top-level structure of the program, though. No detail. Not much info about connections between components. The layout was kind of weird.[1]

Another one, from a fork I have of a rendering library.[2] It found the big parts, but provides little insight.

Here's a JPEG 2000 decoder. Even less insight.[3]

The progress messages are bogus. They have no relationship to what's going on. Progress messages indicating progress appear for a bad URL.

[1] https://gitdiagram.com/John-Nagle/ui-mock

[2] https://gitdiagram.com/John-Nagle/rend3-hp

[3] https://gitdiagram.com/John-Nagle/jpeg2000-decoder

[NathanFlurry]

This is fun! I’ve come across a few tools like this before and almost dismissed it due to past poor experiences. However, I just diagrammed our startup’s codebase, and it was surprisingly similar to our hand-made diagram. I tried customizing it with specific instructions to ignore legacy code & provide an understanding of our edge architecture, but the one-generation-per-day rate limit is a bit restrictive.

For comparison:

- Hand made diagram: https://github.com/rivet-gg/rivet/blob/d45bf556e903404ab2df0...

- GitDiagram (no instructions): https://gitdiagram.com/rivet-gg/rivet

[owenpalmer]

Inputted llvm-project, resulted in this error:

  Repository is too large (>200k tokens) for analysis. Claude 3.5 Sonnet's max context length is 200k tokens. Current size: 1448461 tokens.

[karmakaze]

I tried with sorbet/sorbet:

> File tree and README combined exceeds token limit (50,000). Current size: 159829 tokens. This GitHub repository is too large for my wallet, but you can continue by providing your own Anthropic API key.

Without having an idea of the output it would produce, I can't tell if it's worth it. I'm not particularly interested in this test example so it's something I might try for an easy win, but probably tweak and maintain whatever it produces--or discard it and make something by hand. Showing something subjectively incorrect is good motivation.

[ahmedkhaleel]

1.4M tokens... even if Claude can process that there would be a crater in my wallet

[thih9]

Note: the messages that are displayed during diagram generation seem to describe the current progress - but actually they are generic/comedic messages that run in an endless loop.

Also, I tried this with https://github.com/rails/rails and it never finished.

[dylan604]

Are any of them kicking the llama’s ass while reticulating spines?

[shahzaibmushtaq]

I learn faster with visualization, whether it's a stat or a codebase. Much appreciated!

[ahmedkhaleel]

yup, exact same here, glad to see my project helping others alike

[initramfs]

Wow, this is awesome:

https://gitdiagram.com/EI2030/Low-power-E-Paper-OS

https://gitdiagram.com/hatonthecat/Solar-Kernel

https://gitdiagram.com/hatonthecat/OpenSourceCondo

https://gitdiagram.com/hatonthecat/Open-Source-Car

[jesse__]

Tried https://github.com/scallyw4g/bonsai and I believe it hung after the green loading bar completed. Left it for several minutes

[ahmedkhaleel]

yea i just checked the db, nothing there. thats weird, ill try loading it myself

[jasfi]

I tried it on one of my repos and was somewhat impressed. I'd like to be able to drill down into subsystems though. This sort of tool could help to learn about codebases faster.

[layer8]

I tried this with a larger project, and after looping through the obviously-fake progress messages for a couple of minutes, it resulted in “Failed to generate diagram. Please try again later.”

[WillAdams]

Failed with:

https://github.com/WillAdams/gcodepreview

which is probably the weirdest structure one could imagine (Literate Program as a .tex file containing Python and OpenSCAD code for https://pythonscad.org/ ) there the Python file is the core, there is an intermediate OpenSCAD file which wraps it, and then a top-level OpenSCAD file which the user interacts with.

[blondin]

love this idea! here's ghostty: https://gitdiagram.com/ghostty-org/ghostty

[ahmedkhaleel]

ghostty is sick, and the diagram seems accurate on a higher level

[ssivark]

This kind of capability would be quite nifty as an IDE plugin -- I'd like to get visualizations based on some selected code -- maybe a few lines, files or even a whole project.

[gloosx]

>I created this because I wanted to contribute to open-source projects but quickly realized their codebases are too massive for me to dig through manually

I don't get this statement: tried the first repository with the following result

>Repository is too large (>200k tokens) for analysis

So seems this is not suitable for codebases "too massive" because they are "too large", what to do with these?

[DoingIsLearning]

https://gitdiagram.com/anntzer/mplcursors gave me this err:

Error code: 529 - {'type': 'error', 'error': {'type': 'overloaded_error', 'message': 'Overloaded'}}

I assume Anthropic is suffering...

[nulld3v]

Hashicorp Vault (had to use my own API key as the repo is fairly large): https://gitdiagram.com/hashicorp/vault

Diagram could maybe have a bit more detail but what is there looks accurate! Really cool stuff OP!

[whalesalad]

I hope you have a cap set on your billing!

[ahmedkhaleel]

yup, i did that, i have it currently on balance mode so its not using anything without my knowledge

[visch]

:D , he got a star from me for the ease!

[Minervaskell]

Final boss: https://github.com/torvalds/linux

Error message: Repository is too large (>200k tokens) for analysis. Claude 3.5 Sonnet's max context length is 200k tokens. Current size: 1334798 tokens.

Cool project though! Kudos!

[chris_5f]

This is just amazing. I tried out with my startup's repo and it was a blast. Shared with my community

[ahmedkhaleel]

thank you so much!!

[fsndz]

I have been attempting to do this and failed. Good implementation, but still fails in a lot of cases like my implementation. For example fails for this: https://github.com/stanfordnlp/dspy

[nhatcher]

I tried with mine, of course. It worked quite well I would say:

https://gitdiagram.com/ironcalc/IronCalc

I think the color coding for the legend is incorrect though.

Overall looks great, congratulations and thanks!

[louthy]

Doesn’t like my repo [1]

“Failed to generate diagram. Please try again later.”

[1] https://github.com/louthy/language-ext

[abrookewood]

Looks great, but would love to see it work with Private Repos.

[diamondage]

would love to see this taken further. I note that structure 101 seems to have been bought by sonar (https://www.youtube.com/watch?v=6Mie3Iya4zE) but they did this back in the day for java etc. would love to have an accessible modern add on with the same concepts of fat, tangle etc.

[k0ns0l]

Love what you've built OP

Quick thought: Since you're tackling large codebases, maybe add some zoom controls?

[mparnisari]

It never generated a diagram for mine :(

[ahmedkhaleel]

thats unfortunate, whats the url? ill check it out

[phoenixreader]

That’s very cool! Does it use the source code at all? Or does it just use README and directory tree?

[Jerrrry]

This is the neatest and most useful thing Shown on HN using AI in recent memory.

Well done!

[zackproser]

Ah nicely done! I was just about to build this