CodeBoarding - codebase के लिए interactive architecture diagrams

 (github.com/CodeBoarding)
24 पॉइंट द्वारा xguru 18 시간 전 | अभी कोई टिप्पणी नहीं है. | WhatsApp पर शेयर करें
  • एक open source टूल जो लोगों और AI agents के साथ मिलकर देखने के लिए codebase का मैप अपने-आप बनाता है
  • static analysis और LLM inference को जोड़कर codebase के high-level architecture diagrams और मुख्य component documentation को अपने-आप जनरेट करता है
  • आउटपुट .codeboarding/ directory में Markdown documents और Mermaid diagrams के रूप में सेव होता है, इसलिए इन्हें IDE, CI, PR और docs में सीधे embed किया जा सकता है
  • incremental updates को सपोर्ट करता है, इसलिए जब codebase का केवल कुछ हिस्सा बदला हो तो वही हिस्सा दोबारा analyze किया जाता है और बड़े repositories में भी तेज़ी से काम करता है
  • 6 core components से बना है
    • Application Orchestrator & Repository Manager: analysis workflow शुरू करता है और context पास करता है
    • LLM Agent Core: specialized tools को कॉल करके code और analysis data को संभालता है
    • Static Code Analyzer: code segments का static analysis करता है
    • Agent Tooling Interface: वह interface जिससे agent static analysis engine से query करता है
    • Incremental Analysis Engine: बदले हुए code के लिए ही static analysis request करता है और results cache करता है
    • Documentation & Diagram Generator: analysis results को documents और diagrams में बदलता है
  • उपयोग के scenarios
    • जब AI agents code लिख रहे हों, तब architecture visibility बनाए रखना
    • AI-generated changes को system context के साथ review करके छिपे हुए technical debt को पहले ही रोकना
    • layered diagrams और component breakdown के ज़रिए बड़े repositories को जल्दी समझना
    • local workflow, IDE, PR और docs में वही visual model साझा करना
  • 8 भाषाओं का समर्थन: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
  • कई LLM providers के साथ integration: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter आदि
  • तीन deployment forms में उपलब्ध
    • CLI: local analysis, automation और CI workflows के लिए (pipx install codeboarding)
    • VS Code extension: editor के भीतर visual architecture देखना
    • GitHub Action: CI में diagrams को हमेशा up to date रखना
  • पहले से 800 से अधिक प्रसिद्ध open source repositories को visualize करने वाला sample DB उपलब्ध
  • vision: ऐसा open standard for code understanding बनाना जिसे इंसान और AI agents दोनों इस्तेमाल कर सकें
  • MIT लाइसेंस

संबंधित पढ़ाई

अभी कोई टिप्पणी नहीं है.

अभी कोई टिप्पणी नहीं है.