sydowma/codegpt

CodeGPT is a tool that uses ChatGPT to read and explain code, then automatically turns that explanation into organized Markdown documents. Think of it like having an AI assistant that reads through your codebase and writes down what it does in a clean, readable format. The way it works is straightforward. You point the tool at a GitHub repository (or a folder of code on your computer), give it your OpenAI API key so it can talk to ChatGPT, and it does the rest. The tool analyzes the code files, asks ChatGPT to explain what they do, and saves those explanations as Markdown files. Those files can then be assembled into a book or website format, so you have a complete guide to understanding your codebase without having to write the documentation yourself. This is useful for a few different situations. If you've inherited a large or messy codebase and need to understand what it does, CodeGPT can generate an instant overview. If you're open-sourcing a project but don't want to spend weeks writing documentation, this tool can bootstrap that for you. It's also handy if you're trying to build a knowledge base or tutorial site about existing code, the tool generates the written content, and you just need to organize it. The project is built entirely in Python, which means it runs on Windows, Mac, or Linux without much setup beyond installing dependencies and configuring an OpenAI API key. Right now it's a command-line tool, so you'll need to be comfortable typing commands, but it's fairly simple to use. The README mentions offline support is still on the way, so at the moment you'll need an internet connection to reach OpenAI's servers.