Generate architecture-aware README.md files from your codebase using local LLMs like Ollama.
- [WIP] - Detects tech stack and architecture
- Recursively scans your codebase (with
.promptignoresupport) - Generates Markdown README with Mermaid diagrams
- Uses Ollama to refine summaries and stack descriptions
- Run via
- sweet CLI or
- beautiful Streamlit GUI
- (coming soon) Generates promptable summaries of your codebase
pip install -e .codepromptifyLaunch a web interface to guide you through code-promptify-ing your code.
codepromptify --guicodepromptify --path ./myproject --output docs/README.mdSupports .promptignore like .gitignore.
Example:
node_modules/
*.test.js
build/
.env- Python 3.9+
- (Optional) Ollama with local models like
llama3,gemma, etc.
MIT