{"id":35094366,"url":"https://github.com/chriswritescode-dev/codedox","last_synced_at":"2026-01-17T10:54:14.922Z","repository":{"id":304756515,"uuid":"1019207112","full_name":"chriswritescode-dev/codedox","owner":"chriswritescode-dev","description":" A powerful system for crawling documentation websites, extracting code snippets, and providing fast search capabilities via MCP (Model Context Protocol) integration.","archived":false,"fork":false,"pushed_at":"2025-12-22T03:37:28.000Z","size":5572,"stargazers_count":25,"open_issues_count":2,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-23T07:29:09.801Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chriswritescode-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-14T01:03:14.000Z","updated_at":"2025-12-22T03:37:32.000Z","dependencies_parsed_at":"2025-09-01T02:09:40.107Z","dependency_job_id":"a6f51a2d-daf5-40c2-979c-e728bd703fba","html_url":"https://github.com/chriswritescode-dev/codedox","commit_stats":null,"previous_names":["chriswritescode-dev/codedox"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/chriswritescode-dev/codedox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriswritescode-dev%2Fcodedox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriswritescode-dev%2Fcodedox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriswritescode-dev%2Fcodedox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriswritescode-dev%2Fcodedox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chriswritescode-dev","download_url":"https://codeload.github.com/chriswritescode-dev/codedox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriswritescode-dev%2Fcodedox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28506593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-27T15:04:24.315Z","updated_at":"2026-01-17T10:54:14.916Z","avatar_url":"https://github.com/chriswritescode-dev.png","language":"Python","funding_links":[],"categories":["📚 Projects (1974 total)","Python"],"sub_categories":["Documentation"],"readme":"# CodeDox - AI-Powered Documentation Search \u0026 Code Extraction\n\n**Transform any documentation site into a searchable code database** - CodeDox crawls documentation websites, intelligently extracts code snippets with context, and provides lightning-fast search via PostgreSQL full-text search and MCP (Model Context Protocol) integration for AI assistants.\n\n## 📚 Documentation\n\nFor full documentation, installation guides, API reference, and more, visit:\n\n### **[https://chriswritescode-dev.github.io/codedox/](https://chriswritescode-dev.github.io/codedox/)**\n\n## Quick Start\n\n### Docker Setup (Recommended)\n\n```bash\n# Clone the repository\ngit clone https://github.com/chriswritescode-dev/codedox.git\ncd codedox\n\n# Configure environment\ncp .env.example .env\n# Edit .env to add your CODE_LLM_API_KEY (optional for AI-enhanced extraction)\n\n# Run the automated setup\n./docker-setup.sh\n\n# Access the web UI at http://localhost:5173\n# MCP tools available at http://localhost:8000/mcp\n```\n\n### Manual Installation\n\nSee the [full installation guide](https://chriswritescode-dev.github.io/codedox/getting-started/installation/) for detailed instructions.\n\n## Key Features\n\n- **Intelligent Web Crawling**: Depth-controlled crawling with URL pattern filtering and domain restrictions\n- **Smart Code Extraction**: Dual-mode extraction (Automatic Title / Description or LLM Generated Titles and Descriptions)\n- **Enhanced Search Modes**: Standard code search with intelligent markdown fallback for comprehensive results\n- **Lightning-Fast Search**: PostgreSQL full-text search with fuzzy matching\n- **GitHub Repository Processing**: Clone and extract documentation from GitHub repositories with full path support (e.g., `/tree/main/docs`)\n- **HTTP-First MCP Integration**: MCP tools via HTTP endpoints with Streamable HTTP transport support (MCP 2025-03-26 spec)\n- **Full Documentation Access**: Get complete markdown content from any documentation page for full context\n- **Modern Web Dashboard**: React + TypeScript UI for visual management\n- **Version Support**: Track multiple versions of documentation\n- **Real-time Monitoring**: Live crawl progress and health monitoring\n- **Upload Support**: Upload documentation directly or from GitHub repositories (useful for repos with doc sites)\n\n## Demo - MCP Integration Example - OpenCode TUI\n\n\u003cimg src=\"docs/screenshots/CodeDox-1.gif\" alt=\"CodeDox Demo\" width=\"800\"\u003e\n\n## Screenshots\n\n### Dashboard\n\u003cimg src=\"docs/screenshots/WebUI-Dashboard.webp\" alt=\"CodeDox Dashboard\" width=\"800\"\u003e\n\n### Markdown Search with Highlighting\n\u003cimg src=\"docs/screenshots/CodeDoX-WebUI-Markdown-Search.webp\" alt=\"CodeDox Markdown Search\" width=\"800\"\u003e\n\n### Source Detail View\n\u003cimg src=\"docs/screenshots/WebUI-Source-Detail.webp\" alt=\"CodeDox Source Detail\" width=\"800\"\u003e\n\n## Documentation\n\n- [Getting Started](https://chriswritescode-dev.github.io/codedox/getting-started/quickstart/)\n- [Installation Guide](https://chriswritescode-dev.github.io/codedox/getting-started/installation/)\n- [API Reference](https://chriswritescode-dev.github.io/codedox/api/rest/)\n- [MCP Integration](https://chriswritescode-dev.github.io/codedox/features/mcp/)\n- [Architecture Overview](https://chriswritescode-dev.github.io/codedox/development/architecture/)\n\n## Contributing\n  \n\nSee our [Contributing Guide](https://chriswritescode-dev.github.io/codedox/development/contributing/) for details on how to contribute to CodeDox.\n\n## Author\n\n**Chris Scott** - [chriswritescode.dev](https://chriswritescode.dev)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriswritescode-dev%2Fcodedox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchriswritescode-dev%2Fcodedox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriswritescode-dev%2Fcodedox/lists"}