diff --git a/README.md b/README.md index a38b5eb..0403b3e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
- AI-powered semantic code search for your repositories + Finally understand your codebase
@@ -21,72 +21,79 @@
Quick Start • - Deployment • - MCP Integration • + Docs • Contributing
--- +You know that mass of code you inherited? The one where you spend 20 minutes grep-ing just to find where authentication happens? Where you're scared to change anything because you don't know what might break? + +**OpenCodeIntel fixes that.** + +Search your code by what it *does*, not what it's named. Ask for "error handling" and find it—even when the function is called `processFailure()`. + -## What is OpenCodeIntel? +## See it in action -OpenCodeIntel gives AI coding assistants deep understanding of your codebase. It's an MCP server that provides semantic code search, dependency analysis, and impact prediction. +| You search for... | It finds... | +|-------------------|-------------| +| `"authentication logic"` | `validateJWT()`, `checkSession()`, `authMiddleware.ts` | +| `"where we handle payments"` | `stripe/checkout.ts`, `processRefund()`, `PaymentService` | +| `"error handling"` | `processFailure()`, `onError()`, `catch` blocks across the codebase | -**Search by meaning, not keywords.** Find "error handling logic" even when functions are named `processFailure()`. +No regex. No exact matches. Just describe what you're looking for. -## Features +## What else? -- **Semantic Search** - Vector-based code search that understands intent -- **Dependency Graph** - Visualize how your codebase connects -- **Impact Analysis** - Know what breaks before you change a file -- **Code Style Analysis** - Understand team patterns and conventions -- **MCP Integration** - Works directly with Claude Desktop +**Dependency Graph** — See how your files connect. One glance shows you the architecture. -## Quick Start +**Impact Analysis** — About to change `auth.ts`? Know exactly what breaks before you touch it. + +**Code Style** — Understand your team's patterns. snake_case or camelCase? How are errors handled? -### Using Docker (Recommended) +**Works with Claude** — Connects as an MCP server. Your AI assistant finally understands your codebase. + +## Quick Start ```bash git clone https://github.com/OpenCodeIntel/opencodeintel.git cd opencodeintel cp .env.example .env -# Add your API keys to .env +# Add your API keys docker compose up -d ``` -- Frontend: http://localhost:3000 -- Backend: http://localhost:8000 -- API Docs: http://localhost:8000/docs +Open http://localhost:3000. That's it. -### Manual Setup +