codeboarding 0.9.0__tar.gz

codeboarding-0.9.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 CodeBoarding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codeboarding-0.9.0/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: codeboarding
+Version: 0.9.0
+Summary: Interactive Diagrams for Code
+Author: CodeBoarding Team
+License: MIT
+Project-URL: Repository, https://github.com/CodeBoarding/CodeBoarding
+Project-URL: Documentation, https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/overview.md
+Keywords: code-understanding,code-visualization,code-analysis,diagrams,documentation,llm,static-analysis,mermaid,onboarding
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: <3.14,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: asgiref>=3.9
+Requires-Dist: async-timeout>=4.0
+Requires-Dist: docker>=7.1
+Requires-Dist: dotenv>=0.9
+Requires-Dist: duckdb>=1.3
+Requires-Dist: dulwich>=0.22
+Requires-Dist: email-validator>=2.2
+Requires-Dist: exceptiongroup>=1.2
+Requires-Dist: fastapi>=0.115
+Requires-Dist: filelock>=3.12
+Requires-Dist: gitpython>=3.1
+Requires-Dist: google-genai>=1.10
+Requires-Dist: gql>=3.5
+Requires-Dist: injector>=0.21
+Requires-Dist: ipykernel>=6.29
+Requires-Dist: isort>=6.0
+Requires-Dist: jsonschema>=4.25
+Requires-Dist: langchain>=1.2
+Requires-Dist: langchain-anthropic>=1.3
+Requires-Dist: langchain-aws>=1.1
+Requires-Dist: langchain-cerebras>=0.8
+Requires-Dist: langchain-community>=0.4
+Requires-Dist: langchain-google-genai>=3.1
+Requires-Dist: langchain-ollama>=1.0
+Requires-Dist: langchain-openai>=1.1
+Requires-Dist: markdown>=3.8
+Requires-Dist: markdown-it-py>=3.0
+Requires-Dist: markitdown>=0.1
+Requires-Dist: matplotlib>=3.10
+Requires-Dist: networkx>=3.4
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: pandas>=2.2
+Requires-Dist: pathspec>=0.12
+Requires-Dist: pydot>=3.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: regex>=2024.11
+Requires-Dist: rich>=12.6
+Requires-Dist: seaborn>=0.13
+Requires-Dist: tomli>=2.2
+Requires-Dist: trustcall>=0.0.39
+Requires-Dist: typer>=0.9
+Requires-Dist: uvicorn>=0.23
+Requires-Dist: wcwidth>=0.2.13
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-cov>=7.0; extra == "dev"
+Requires-Dist: black>=25.9; extra == "dev"
+Requires-Dist: mypy>=1.19; extra == "dev"
+Requires-Dist: pre-commit>=3.8; extra == "dev"
+Provides-Extra: all
+Requires-Dist: codeboarding[dev]; extra == "all"
+Requires-Dist: pylint>=3.3; extra == "all"
+Requires-Dist: pyright>=1.1; extra == "all"
+Requires-Dist: pyinstaller>=6.13; extra == "all"
+Requires-Dist: memory-profiler>=0.61; extra == "all"
+Dynamic: license-file
+
+# CodeBoarding
+
+[![Website](https://img.shields.io/badge/Site-CodeBoarding.org-5865F2?style=for-the-badge&logoColor=white)](https://codeboarding.org)
+[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?style=for-the-badge&logoColor=white)](https://discord.gg/T5zHTJYFuy)
+[![GitHub](https://img.shields.io/badge/GitHub-CodeBoarding-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/CodeBoarding/CodeBoarding)
+
+**CodeBoarding** generates interactive architectural diagrams from any codebase using static analysis + LLM agents. It's built for developers and AI agents that need to understand large, complex systems quickly.
+
+- Extracts modules and relationships via control flow graph analysis (LSP-based, no runtime required)
+- Builds layered abstractions with an LLM agent (OpenAI, Anthropic, Google Gemini, Ollama, and more)
+- Outputs Mermaid.js diagrams ready for docs, IDEs, and CI/CD pipelines
+
+**Supported languages:** Python · TypeScript · JavaScript · Java · Go · PHP
+
+---
+
+## Installation
+
+```bash
+pip install codeboarding
+```
+
+Language server binaries are downloaded automatically on first use. To pre-install them explicitly (useful in CI or restricted environments):
+
+```bash
+codeboarding-setup
+```
+
+> `npm` is required (used for Python, TypeScript, JavaScript, and PHP language servers). If `npm` is not found, it will be automatically installed during the setup. Binaries are stored in `~/.codeboarding/servers/` and shared across all projects.
+
+---
+
+## Quick Start
+
+### CLI
+
+```bash
+# Analyze a local repository (output goes to /path/to/repo/.codeboarding/)
+codeboarding --local /path/to/repo
+
+# Analyze a remote GitHub repository (cloned to cwd/repo_name/, output to cwd/repo_name/.codeboarding/)
+codeboarding https://github.com/user/repo
+```
+
+### Python API
+
+```python
+import json
+from pathlib import Path
+from diagram_analysis import DiagramGenerator, configure_models
+from diagram_analysis.analysis_json import parse_unified_analysis
+
+# Pass the key programmatically — shell env vars always take precedence if already set.
+# Use the env-var name for whichever provider you want:
+#   OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY, OLLAMA_BASE_URL, …
+configure_models(api_keys={"OPENAI_API_KEY": "sk-..."})
+
+repo_path = Path("/path/to/repo")
+output_dir = repo_path / ".codeboarding"
+output_dir.mkdir(parents=True, exist_ok=True)
+
+# Generate the architectural diagram
+generator = DiagramGenerator(
+    repo_location=repo_path,
+    temp_folder=output_dir,
+    repo_name="my-project",
+    output_dir=output_dir,
+    depth_level=1,
+)
+[analysis_path] = generator.generate_analysis()
+
+# Read and inspect the results
+with open(analysis_path) as f:
+    data = json.load(f)
+
+root, sub_analyses = parse_unified_analysis(data)
+
+print(root.description)
+for comp in root.components:
+    print(f"  {comp.name}: {comp.description}")
+    if comp.component_id in sub_analyses:
+        for sub in sub_analyses[comp.component_id].components:
+            print(f"    └ {sub.name}")
+```
+
+---
+
+## Configuration
+
+LLM provider keys and model overrides are stored in `~/.codeboarding/config.toml`, created automatically on first run:
+
+```toml
+# ~/.codeboarding/config.toml
+
+[provider]
+# Uncomment exactly one provider key
+# openai_api_key    = "sk-..."
+# anthropic_api_key = "sk-ant-..."
+# google_api_key    = "AIza..."
+# ollama_base_url   = "http://localhost:11434"
+
+[llm]
+# Optional: override the default model for your active provider
+# agent_model   = "gemini-3-flash"
+# parsing_model = "gemini-3-flash"
+```
+
+Shell environment variables (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.) always take precedence over the config file, so CI/CD pipelines need no changes. For private repositories, set `GITHUB_TOKEN` in your environment.
+
+> **Tip:** Google Gemini 3 Pro consistently produces the best diagram quality for complex codebases.
+
+---
+
+## CLI Reference
+
+```
+codeboarding [REPO_URL ...]           # remote: clone + analyze
+codeboarding --local PATH             # local: analyze in-place
+```
+
+| Option | Description |
+|---|---|
+| `--local PATH` | Analyze a local repository (output: `PATH/.codeboarding/`) |
+| `--depth-level INT` | Diagram depth (default: 1) |
+| `--incremental` | Smart incremental update (only re-analyze changed files) |
+| `--full` | Force full reanalysis, skip incremental detection |
+| `--partial-component-id ID` | Update a single component by its ID |
+| `--binary-location PATH` | Custom path to language server binaries (overrides `~/.codeboarding/servers/`) |
+| `--upload` | Upload results to GeneratedOnBoardings repo (remote only) |
+| `--enable-monitoring` | Enable run monitoring |
+
+---
+
+## Integrations
+
+- **[VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Codeboarding.codeboarding)** — browse diagrams directly in your IDE
+- **[GitHub Action](https://github.com/marketplace/actions/codeboarding-diagram-first-documentation)** — generate docs on every push
+- **[MCP Server](https://github.com/CodeBoarding/CodeBoarding-MCP)** — serve concise architecture docs to AI coding assistants (Claude Code, Cursor, etc.)
+
+---
+
+## Links
+
+- [Source code](https://github.com/CodeBoarding/CodeBoarding)
+- [Example diagrams (800+ open-source projects)](https://github.com/CodeBoarding/GeneratedOnBoardings)
+- [Architecture documentation](https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/overview.md)
+- [Discord community](https://discord.gg/T5zHTJYFuy)

codeboarding-0.9.0/PYPI.md

@@ -0,0 +1,147 @@
+# CodeBoarding
+
+[![Website](https://img.shields.io/badge/Site-CodeBoarding.org-5865F2?style=for-the-badge&logoColor=white)](https://codeboarding.org)
+[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?style=for-the-badge&logoColor=white)](https://discord.gg/T5zHTJYFuy)
+[![GitHub](https://img.shields.io/badge/GitHub-CodeBoarding-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/CodeBoarding/CodeBoarding)
+
+**CodeBoarding** generates interactive architectural diagrams from any codebase using static analysis + LLM agents. It's built for developers and AI agents that need to understand large, complex systems quickly.
+
+- Extracts modules and relationships via control flow graph analysis (LSP-based, no runtime required)
+- Builds layered abstractions with an LLM agent (OpenAI, Anthropic, Google Gemini, Ollama, and more)
+- Outputs Mermaid.js diagrams ready for docs, IDEs, and CI/CD pipelines
+
+**Supported languages:** Python · TypeScript · JavaScript · Java · Go · PHP
+
+---
+
+## Installation
+
+```bash
+pip install codeboarding
+```
+
+Language server binaries are downloaded automatically on first use. To pre-install them explicitly (useful in CI or restricted environments):
+
+```bash
+codeboarding-setup
+```
+
+> `npm` is required (used for Python, TypeScript, JavaScript, and PHP language servers). If `npm` is not found, it will be automatically installed during the setup. Binaries are stored in `~/.codeboarding/servers/` and shared across all projects.
+
+---
+
+## Quick Start
+
+### CLI
+
+```bash
+# Analyze a local repository (output goes to /path/to/repo/.codeboarding/)
+codeboarding --local /path/to/repo
+
+# Analyze a remote GitHub repository (cloned to cwd/repo_name/, output to cwd/repo_name/.codeboarding/)
+codeboarding https://github.com/user/repo
+```
+
+### Python API
+
+```python
+import json
+from pathlib import Path
+from diagram_analysis import DiagramGenerator, configure_models
+from diagram_analysis.analysis_json import parse_unified_analysis
+
+# Pass the key programmatically — shell env vars always take precedence if already set.
+# Use the env-var name for whichever provider you want:
+#   OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY, OLLAMA_BASE_URL, …
+configure_models(api_keys={"OPENAI_API_KEY": "sk-..."})
+
+repo_path = Path("/path/to/repo")
+output_dir = repo_path / ".codeboarding"
+output_dir.mkdir(parents=True, exist_ok=True)
+
+# Generate the architectural diagram
+generator = DiagramGenerator(
+    repo_location=repo_path,
+    temp_folder=output_dir,
+    repo_name="my-project",
+    output_dir=output_dir,
+    depth_level=1,
+)
+[analysis_path] = generator.generate_analysis()
+
+# Read and inspect the results
+with open(analysis_path) as f:
+    data = json.load(f)
+
+root, sub_analyses = parse_unified_analysis(data)
+
+print(root.description)
+for comp in root.components:
+    print(f"  {comp.name}: {comp.description}")
+    if comp.component_id in sub_analyses:
+        for sub in sub_analyses[comp.component_id].components:
+            print(f"    └ {sub.name}")
+```
+
+---
+
+## Configuration
+
+LLM provider keys and model overrides are stored in `~/.codeboarding/config.toml`, created automatically on first run:
+
+```toml
+# ~/.codeboarding/config.toml
+
+[provider]
+# Uncomment exactly one provider key
+# openai_api_key    = "sk-..."
+# anthropic_api_key = "sk-ant-..."
+# google_api_key    = "AIza..."
+# ollama_base_url   = "http://localhost:11434"
+
+[llm]
+# Optional: override the default model for your active provider
+# agent_model   = "gemini-3-flash"
+# parsing_model = "gemini-3-flash"
+```
+
+Shell environment variables (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.) always take precedence over the config file, so CI/CD pipelines need no changes. For private repositories, set `GITHUB_TOKEN` in your environment.
+
+> **Tip:** Google Gemini 3 Pro consistently produces the best diagram quality for complex codebases.
+
+---
+
+## CLI Reference
+
+```
+codeboarding [REPO_URL ...]           # remote: clone + analyze
+codeboarding --local PATH             # local: analyze in-place
+```
+
+| Option | Description |
+|---|---|
+| `--local PATH` | Analyze a local repository (output: `PATH/.codeboarding/`) |
+| `--depth-level INT` | Diagram depth (default: 1) |
+| `--incremental` | Smart incremental update (only re-analyze changed files) |
+| `--full` | Force full reanalysis, skip incremental detection |
+| `--partial-component-id ID` | Update a single component by its ID |
+| `--binary-location PATH` | Custom path to language server binaries (overrides `~/.codeboarding/servers/`) |
+| `--upload` | Upload results to GeneratedOnBoardings repo (remote only) |
+| `--enable-monitoring` | Enable run monitoring |
+
+---
+
+## Integrations
+
+- **[VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Codeboarding.codeboarding)** — browse diagrams directly in your IDE
+- **[GitHub Action](https://github.com/marketplace/actions/codeboarding-diagram-first-documentation)** — generate docs on every push
+- **[MCP Server](https://github.com/CodeBoarding/CodeBoarding-MCP)** — serve concise architecture docs to AI coding assistants (Claude Code, Cursor, etc.)
+
+---
+
+## Links
+
+- [Source code](https://github.com/CodeBoarding/CodeBoarding)
+- [Example diagrams (800+ open-source projects)](https://github.com/CodeBoarding/GeneratedOnBoardings)
+- [Architecture documentation](https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/overview.md)
+- [Discord community](https://discord.gg/T5zHTJYFuy)

codeboarding-0.9.0/README.md

@@ -0,0 +1,281 @@
+# <img src="./icon.svg" alt="CodeBoarding Logo" width="30" height="30" style="vertical-align: middle;"> CodeBoarding
+
+[![Website](https://img.shields.io/badge/Site-CodeBoarding.org-5865F2?style=for-the-badge&logoColor=white)](https://codeboarding.org)
+[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?style=for-the-badge&logoColor=white)](https://discord.gg/T5zHTJYFuy)
+[![VS Code Extension](https://img.shields.io/visual-studio-marketplace/i/Codeboarding.codeboarding?style=for-the-badge&logo=visual-studio-code&logoColor=white&label=VS%20Code%20Extension&color=blue)](https://marketplace.visualstudio.com/items?itemName=Codeboarding.codeboarding)
+[![AI IDE Extension](https://img.shields.io/open-vsx/v/CodeBoarding/codeboarding?style=for-the-badge&logo=visual-studio-code&label=AI%20IDE%20Extension)](https://open-vsx.org/extension/CodeBoarding/codeboarding)
+
+
+
+**Supported Languages:**
+
+[![Python Support](https://img.shields.io/badge/Python-Supported-green?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
+[![TypeScript Support](https://img.shields.io/badge/TypeScript-Supported-blue?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![JavaScript Support](https://img.shields.io/badge/JavaScript-Supported-yellow?style=for-the-badge&logo=javascript&logoColor=white)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
+[![Java Support](https://img.shields.io/badge/Java-Supported-orange?style=for-the-badge&logo=java&logoColor=white)](https://www.java.com/)
+[![Go Support](https://img.shields.io/badge/Go-Supported-00ADD8?style=for-the-badge&logo=go&logoColor=white)](https://go.dev/)
+[![PHP Support](https://img.shields.io/badge/PHP-Supported-777BB4?style=for-the-badge&logo=php&logoColor=white)](https://www.php.net/)
+
+**CodeBoarding** is an open-source codebase analysis tool that generates high-level diagram representations of codebases
+using static analysis and LLM agents, that humans and agents can interact with.  
+It’s designed to support onboarding, documentation, and comprehension for large, complex systems.
+
+- Extract modules and their relationships based on the control flow graph of the project.
+- Builds different levels of abstraction with an LLM agent (multi-provider support) using remote or local inference.
+- Outputs interactive diagrams (Mermaid.js) for integration into docs, IDEs, CI/CD.
+
+📄 Existing visual generations: [GeneratedOnBoardings](https://github.com/CodeBoarding/GeneratedOnBoardings)  
+🌐 Try for your open-source project: [www.codeboarding.org/diagrams](https://www.codeboarding.org/diagrams)
+
+## 🧩 How it works
+
+For detailed architecture information, see our [diagram documentation](.codeboarding/overview.md).
+
+```mermaid
+graph LR
+    API_Service["API Service"]
+    Job_Database["Job Database"]
+    Orchestration_Engine["Orchestration Engine"]
+    Repository_Manager["Repository Manager"]
+    Static_Analysis_Engine["Static Analysis Engine"]
+    AI_Interpretation_Layer["AI Interpretation Layer"]
+    Output_Generation_Engine["Output Generation Engine"]
+    Unclassified["Unclassified"]
+    API_Service -- " Initiates Job " --> Job_Database
+    API_Service -- " Triggers Analysis " --> Orchestration_Engine
+    Orchestration_Engine -- " Manages Job State " --> Job_Database
+    Orchestration_Engine -- " Requests Code " --> Repository_Manager
+    Repository_Manager -- " Provides Code " --> Orchestration_Engine
+    Orchestration_Engine -- " Requests Static Analysis " --> Static_Analysis_Engine
+    Static_Analysis_Engine -- " Provides Richer Analysis Results " --> Orchestration_Engine
+    Orchestration_Engine -- " Feeds Rich Analysis Data " --> AI_Interpretation_Layer
+    AI_Interpretation_Layer -- " Returns Enhanced Architectural Insights " --> Orchestration_Engine
+    AI_Interpretation_Layer -- " Queries Diff " --> Repository_Manager
+    Orchestration_Engine -- " Passes Enhanced Insights for Generation " --> Output_Generation_Engine
+    Output_Generation_Engine -- " Delivers Documentation " --> API_Service
+    click Job_Database href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/Job_Database.md" "Details"
+    click Orchestration_Engine href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/Orchestration_Engine.md" "Details"
+    click Repository_Manager href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/Repository_Manager.md" "Details"
+    click Static_Analysis_Engine href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/Static_Analysis_Engine.md" "Details"
+    click AI_Interpretation_Layer href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/AI_Interpretation_Layer.md" "Details"
+    click Output_Generation_Engine href "https://github.com/CodeBoarding/CodeBoarding/blob/main/.codeboarding/Output_Generation_Engine.md" "Details"
+```
+
+## 📌 Setup
+
+First, make sure you have uv installed. Check the official installation guide: [Installing UV](https://docs.astral.sh/uv/getting-started/installation/).
+
+Set up the environment:
+
+```bash
+uv sync --frozen
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+python install.py
+```
+
+> [!IMPORTANT]
+> `python install.py` downloads language server binaries to `~/.codeboarding/servers/` (shared across all projects).
+> `npm` is required (used for Python, TypeScript, JavaScript, and PHP language servers). If `npm` is not found, you will be prompted to install it via `nodeenv`; declining will abort setup.
+
+### Configuration
+
+LLM provider keys and model overrides live in `~/.codeboarding/config.toml`, created automatically on first run:
+
+```toml
+# ~/.codeboarding/config.toml
+
+[provider]
+# Uncomment exactly one provider key
+# openai_api_key    = "sk-..."
+# anthropic_api_key = "sk-ant-..."
+# google_api_key    = "AIza..."
+# vercel_api_key    = "vck_..."
+# ollama_base_url   = "http://localhost:11434"
+
+[llm]
+# Optional: override the default model for your active provider
+# agent_model   = "gemini-3-flash"
+# parsing_model = "gemini-3-flash"
+```
+
+Shell environment variables (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.) always take precedence over the config file, so CI/CD pipelines need no changes.
+
+For private repositories, set `GITHUB_TOKEN` in your environment.
+
+> 💡 **Tip:** Our experience has shown that using **Google Gemini‑2.5‑Pro** yields the best results for complex diagram
+> generation tasks.
+
+### Run it
+
+#### Basic Usage
+
+```bash
+# Analyze a local repository (output written to /path/to/repo/.codeboarding/)
+python main.py --local /path/to/repo
+
+# Analyze a remote repository (cloned to cwd/<repo_name>/, output to cwd/<repo_name>/.codeboarding/)
+python main.py https://github.com/user/repo
+```
+
+#### Command-Line Arguments
+
+**Repository selection (required, choose one):**
+- `<repository_url> ...` — One or more GitHub repository URLs to analyze
+- `--local <path>` — Path to a local repository
+
+**Analysis options:**
+- `--depth-level <int>` — Diagram depth (default: `1`)
+- `--incremental` — Smart incremental update (re-analyze changed files only)
+- `--full` — Force full reanalysis, skip incremental detection
+- `--partial-component-id <id>` — Update a single component by its ID (local repos only)
+
+**Advanced:**
+- `--binary-location <path>` — Custom path to language server binaries (overrides `~/.codeboarding/servers/`)
+- `--upload` — Upload results to GeneratedOnBoardings repo (remote repos only)
+- `--enable-monitoring` — Enable run monitoring
+
+#### Examples
+
+```bash
+# Analyze a local repository
+python main.py --local ./my-project
+
+# Analyze with custom depth
+python main.py --local ./my-project --depth-level 2
+
+# Analyze a remote repository
+python main.py https://github.com/pytorch/pytorch
+
+# Analyze multiple remote repositories
+python main.py https://github.com/user/repo1 https://github.com/user/repo2
+
+# Incremental update (re-analyze only changed components)
+python main.py --local ./my-project --incremental
+
+# Update a single component by ID
+python main.py --local ./my-project --partial-component-id "a3f2b1c4d5e6f789"
+```
+
+## 🖥️ Examples:
+
+We have visualized **over 800+ popular open-source projects**. See examples:
+
+### PyTorch:
+
+```mermaid
+graph LR
+    Tensor_Operations_Core["Tensor Operations & Core"]
+    Automatic_Differentiation_Autograd_Engine_["Automatic Differentiation (Autograd Engine)"]
+    Neural_Network_Modules_torch_nn_["Neural Network Modules (torch.nn)"]
+    Optimizers_torch_optim_["Optimizers (torch.optim)"]
+    Data_Utilities_torch_utils_data_["Data Utilities (torch.utils.data)"]
+    JIT_Compiler_Scripting_TorchScript_["JIT Compiler & Scripting (TorchScript)"]
+    Hardware_Backends["Hardware Backends"]
+    Data_Utilities_torch_utils_data_ -- " provides data to " --> Tensor_Operations_Core
+    Tensor_Operations_Core -- " provides primitives for " --> Neural_Network_Modules_torch_nn_
+    Tensor_Operations_Core -- " leverages " --> Hardware_Backends
+    Neural_Network_Modules_torch_nn_ -- " performs operations on " --> Tensor_Operations_Core
+    Neural_Network_Modules_torch_nn_ -- " operations recorded by " --> Automatic_Differentiation_Autograd_Engine_
+    Neural_Network_Modules_torch_nn_ -- " exported to " --> JIT_Compiler_Scripting_TorchScript_
+    Automatic_Differentiation_Autograd_Engine_ -- " computes gradients for " --> Optimizers_torch_optim_
+    Optimizers_torch_optim_ -- " updates parameters of " --> Neural_Network_Modules_torch_nn_
+    Hardware_Backends -- " executes computations for " --> Tensor_Operations_Core
+    click Tensor_Operations_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Tensor_Operations_Core.md" "Details"
+    click Automatic_Differentiation_Autograd_Engine_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Automatic_Differentiation_Autograd_Engine_.md" "Details"
+    click Neural_Network_Modules_torch_nn_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Neural_Network_Modules_torch_nn_.md" "Details"
+    click Optimizers_torch_optim_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Optimizers_torch_optim_.md" "Details"
+    click Data_Utilities_torch_utils_data_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Data_Utilities_torch_utils_data_.md" "Details"
+    click JIT_Compiler_Scripting_TorchScript_ href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/JIT_Compiler_Scripting_TorchScript_.md" "Details"
+    click Hardware_Backends href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/pytorch/Hardware_Backends.md" "Details"
+```
+
+### FastAPI:
+
+```mermaid
+graph LR
+    Application_Core["Application Core"]
+    Middleware["Middleware"]
+    Routing["Routing"]
+    Request_Handling_Validation["Request Handling & Validation"]
+    Dependency_Injection["Dependency Injection"]
+    Security["Security"]
+    Response_Handling["Response Handling"]
+    API_Documentation["API Documentation"]
+    Application_Core -- " sends request to " --> Middleware
+    Middleware -- " forwards request to " --> Routing
+    Routing -- " uses " --> Request_Handling_Validation
+    Routing -- " uses " --> Dependency_Injection
+    Routing -- " provides data for " --> Response_Handling
+    Dependency_Injection -- " enables " --> Security
+    Response_Handling -- " sends response to " --> Middleware
+    API_Documentation -- " inspects " --> Routing
+    API_Documentation -- " inspects " --> Request_Handling_Validation
+    click Application_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Application_Core.md" "Details"
+    click Middleware href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Middleware.md" "Details"
+    click Routing href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Routing.md" "Details"
+    click Request_Handling_Validation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Request_Handling_Validation.md" "Details"
+    click Dependency_Injection href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Dependency_Injection.md" "Details"
+    click Security href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/Security.md" "Details"
+    click API_Documentation href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/fastapi/API_Documentation.md" "Details"
+```
+
+### ChatTTS:
+
+```mermaid
+graph LR
+    ChatTTS_Core_Orchestrator["ChatTTS Core Orchestrator"]
+    Text_Processing_Module["Text Processing Module"]
+    Speech_Synthesis_Models["Speech Synthesis Models"]
+    Velocity_Inference_Engine["Velocity Inference Engine"]
+    System_Utilities_Configuration["System Utilities & Configuration"]
+    ChatTTS_Core_Orchestrator -- " Orchestrates Text Flow " --> Text_Processing_Module
+    ChatTTS_Core_Orchestrator -- " Receives Processed Text " --> Text_Processing_Module
+    ChatTTS_Core_Orchestrator -- " Orchestrates Synthesis Flow " --> Speech_Synthesis_Models
+    ChatTTS_Core_Orchestrator -- " Receives Audio Output " --> Speech_Synthesis_Models
+    ChatTTS_Core_Orchestrator -- " Initializes & Configures " --> System_Utilities_Configuration
+    ChatTTS_Core_Orchestrator -- " Loads Assets " --> System_Utilities_Configuration
+    Text_Processing_Module -- " Receives Raw Text " --> ChatTTS_Core_Orchestrator
+    Text_Processing_Module -- " Provides Processed Text " --> ChatTTS_Core_Orchestrator
+    Speech_Synthesis_Models -- " Receives Processed Data " --> ChatTTS_Core_Orchestrator
+    Speech_Synthesis_Models -- " Generates Audio Output " --> ChatTTS_Core_Orchestrator
+    Speech_Synthesis_Models -- " Delegates Inference To " --> Velocity_Inference_Engine
+    Speech_Synthesis_Models -- " Receives Inference Results " --> Velocity_Inference_Engine
+    Speech_Synthesis_Models -- " Utilizes GPU Resources " --> System_Utilities_Configuration
+    Speech_Synthesis_Models -- " Accesses Model Config " --> System_Utilities_Configuration
+    Velocity_Inference_Engine -- " Executes Model Inference " --> Speech_Synthesis_Models
+    Velocity_Inference_Engine -- " Returns Inference Output " --> Speech_Synthesis_Models
+    Velocity_Inference_Engine -- " Receives Engine Configuration " --> System_Utilities_Configuration
+    System_Utilities_Configuration -- " Provides Assets & Config " --> ChatTTS_Core_Orchestrator
+    System_Utilities_Configuration -- " Provides GPU & Config " --> Speech_Synthesis_Models
+    System_Utilities_Configuration -- " Provides Engine Config " --> Velocity_Inference_Engine
+    click ChatTTS_Core_Orchestrator href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//ChatTTS/ChatTTS_Core_Orchestrator.md" "Details"
+    click Text_Processing_Module href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//ChatTTS/Text_Processing_Module.md" "Details"
+    click Speech_Synthesis_Models href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//ChatTTS/Speech_Synthesis_Models.md" "Details"
+    click Velocity_Inference_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//ChatTTS/Velocity_Inference_Engine.md" "Details"
+    click System_Utilities_Configuration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main//ChatTTS/System_Utilities_Configuration.md" "Details"
+```
+
+Browse more examples: [GeneratedOnBoardings Repository](https://github.com/CodeBoarding/GeneratedOnBoardings)
+
+## 🚀 Integrations
+
+Codeboarding is integrated with everything we use:
+
+- 📦 [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=Codeboarding.codeboarding): Interact
+  with the diagram directly in your IDE.
+- ⚙️ [**GitHub Action**](https://github.com/marketplace/actions/codeboarding-diagram-first-documentation): Automate
+  diagram generation in CI/CD.
+- 🔗 [**MCP Server**](https://github.com/CodeBoarding/CodeBoarding-MCP): Serves the concise documentation to your AI
+  Agent assistant (ClaudeCode, VSCode, Cursor, etc.)
+
+## 🤝 Contributing
+
+We’re just getting started and would love your help!
+If you have ideas, spot bugs, or want to improve anything -
+please [open an issue](https://github.com/CodeBoarding/CodeBoarding/issues) or tackle an existing one.
+We actively track suggestions and welcome pull requests of all sizes.
+
+## 🔮 Vision
+
+**Unified high-level representation for codebases that is accurate** (hence static analysis). This representation is
+used by both people and agents → fully integrated in IDEs, MCP servers, and development workflows.