Gitingest

# GitIngest – **AI Agent Integration Guide** Turn any Git repository into a prompt-ready text digest. GitIngest fetches, cleans, and formats source code so AI agents and Large Language Models can reason over complete projects programmatically. **🤖 For AI Agents**: Use CLI or Python package for automated integration. Web UI is designed for human interaction only. --- ## 1. Installation ### 1.1 CLI Installation (Recommended for Scripts & Automation) ```bash # Best practice: Use pipx for CLI tools (isolated environment) pipx install gitingest # Alternative: Use pip (may conflict with other packages) pip install gitingest # Verify installation gitingest --help ``` ### 1.2 Python Package Installation (For Code Integration) ```bash # For projects/notebooks: Use pip in virtual environment python -m venv gitingest-env source gitingest-env/bin/activate # On Windows: gitingest-env\Scripts\activate pip install gitingest # Or add to requirements.txt echo "gitingest" >> requirements.txt pip install -r requirements.txt # For self-hosting: Install with server dependencies pip install gitingest[server] # For development: Install with dev dependencies pip install gitingest[dev,server] ``` ### 1.3 Installation Verification ```bash # Test CLI installation gitingest --version # Test Python package python -c "from gitingest import ingest; print('GitIngest installed successfully')" # Quick functionality test gitingest https://github.com/octocat/Hello-World -o test_output.txt ``` --- ## 2. Quick-Start for AI Agents | Method | Best for | One-liner | |--------|----------|-----------| | **CLI** | Scripts, automation, pipelines | `gitingest https://github.com/user/repo -o - \| your-llm` | | **Python** | Code integration, notebooks, async tasks | `from gitingest import ingest; s,t,c = ingest('repo-url'); process(c)` | | **URL Hack** | Quick web scraping (limited) | Replace `github.com` → `gitingest.com` in any GitHub URL | | **Web UI** | **Human use only** | ~~Not recomme

{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"Health Check","description":"Health check endpoint to verify that the server is running.\n\n**Returns**\n\n- **dict[str, str]**: A JSON object with a \"status\" key indicating the server's health status.","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object"