Skip to content

Commit f67e416

Browse files
authored
Merge branch 'main' into dependabot/npm_and_yarn/frontend/react-router-dom-7.12.0
2 parents 94aacc4 + d505919 commit f67e416

1 file changed

Lines changed: 54 additions & 50 deletions

File tree

README.md

Lines changed: 54 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</p>
55

66
<p align="center">
7-
<strong>AI-powered semantic code search for your repositories</strong>
7+
<strong>Finally understand your codebase</strong>
88
</p>
99

1010
<p align="center">
@@ -21,72 +21,79 @@
2121

2222
<p align="center">
2323
<a href="#quick-start">Quick Start</a> •
24-
<a href="./docs/deployment.md">Deployment</a> •
25-
<a href="./docs/mcp-setup.md">MCP Integration</a> •
24+
<a href="./docs/deployment.md">Docs</a> •
2625
<a href="./CONTRIBUTING.md">Contributing</a>
2726
</p>
2827

2928
---
3029

30+
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?
31+
32+
**OpenCodeIntel fixes that.**
33+
34+
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()`.
35+
3136
<!-- Demo screenshot placeholder -->
3237
<!-- <p align="center">
33-
<img src="docs/assets/demo.png" alt="OpenCodeIntel Dashboard" width="800" />
38+
<img src="docs/assets/demo.png" alt="OpenCodeIntel Demo" width="800" />
3439
</p> -->
3540

36-
## What is OpenCodeIntel?
41+
## See it in action
3742

38-
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.
43+
| You search for... | It finds... |
44+
|-------------------|-------------|
45+
| `"authentication logic"` | `validateJWT()`, `checkSession()`, `authMiddleware.ts` |
46+
| `"where we handle payments"` | `stripe/checkout.ts`, `processRefund()`, `PaymentService` |
47+
| `"error handling"` | `processFailure()`, `onError()`, `catch` blocks across the codebase |
3948

40-
**Search by meaning, not keywords.** Find "error handling logic" even when functions are named `processFailure()`.
49+
No regex. No exact matches. Just describe what you're looking for.
4150

42-
## Features
51+
## What else?
4352

44-
- **Semantic Search** - Vector-based code search that understands intent
45-
- **Dependency Graph** - Visualize how your codebase connects
46-
- **Impact Analysis** - Know what breaks before you change a file
47-
- **Code Style Analysis** - Understand team patterns and conventions
48-
- **MCP Integration** - Works directly with Claude Desktop
53+
**Dependency Graph** — See how your files connect. One glance shows you the architecture.
4954

50-
## Quick Start
55+
**Impact Analysis** — About to change `auth.ts`? Know exactly what breaks before you touch it.
56+
57+
**Code Style** — Understand your team's patterns. snake_case or camelCase? How are errors handled?
5158

52-
### Using Docker (Recommended)
59+
**Works with Claude** — Connects as an MCP server. Your AI assistant finally understands your codebase.
60+
61+
## Quick Start
5362

5463
```bash
5564
git clone https://github.com/OpenCodeIntel/opencodeintel.git
5665
cd opencodeintel
5766

5867
cp .env.example .env
59-
# Add your API keys to .env
68+
# Add your API keys
6069

6170
docker compose up -d
6271
```
6372

64-
- Frontend: http://localhost:3000
65-
- Backend: http://localhost:8000
66-
- API Docs: http://localhost:8000/docs
73+
Open http://localhost:3000. That's it.
6774

68-
### Manual Setup
75+
<details>
76+
<summary><strong>Manual setup (without Docker)</strong></summary>
6977

7078
**Requirements:** Python 3.11+, Node.js 20+
7179

7280
```bash
7381
# Backend
7482
cd backend
75-
python -m venv venv
76-
source venv/bin/activate
83+
python -m venv venv && source venv/bin/activate
7784
pip install -r requirements.txt
7885
cp .env.example .env
7986
python main.py
8087

8188
# Frontend (new terminal)
8289
cd frontend
83-
npm install
84-
npm run dev
90+
npm install && npm run dev
8591
```
8692

87-
## MCP Integration
93+
</details>
8894

89-
Connect OpenCodeIntel to Claude Desktop for AI-powered code assistance.
95+
<details>
96+
<summary><strong>Connect to Claude Desktop (MCP)</strong></summary>
9097

9198
Add to your Claude Desktop config:
9299

@@ -105,41 +112,38 @@ Add to your Claude Desktop config:
105112
}
106113
```
107114

108-
**Available tools:** `search_code`, `list_repositories`, `get_dependency_graph`, `analyze_code_style`, `analyze_impact`, `get_repository_insights`
115+
See [full MCP setup guide](./docs/mcp-setup.md).
109116

110-
See [MCP Setup Guide](./docs/mcp-setup.md) for detailed instructions.
117+
</details>
111118

112119
## Architecture
113120

114121
```
115-
Frontend (React + TypeScript)
116-
117-
Backend (FastAPI + Python)
118-
119-
┌────┴────┬────────────┐
120-
Pinecone Supabase Redis
121-
(vectors) (database) (cache)
122+
┌─────────────────────────────────────────┐
123+
│ Frontend (React) │
124+
└─────────────────┬───────────────────────┘
125+
126+
┌─────────────────▼───────────────────────┐
127+
│ Backend (FastAPI) │
128+
└───────┬─────────┬─────────┬─────────────┘
129+
│ │ │
130+
┌────▼───┐ ┌───▼────┐ ┌──▼───┐
131+
│Pinecone│ │Supabase│ │Redis │
132+
│vectors │ │database│ │cache │
133+
└────────┘ └────────┘ └──────┘
122134
```
123135

124-
**Stack:** FastAPI, React, TypeScript, Pinecone, Supabase, Redis, tree-sitter
136+
## Docs
125137

126-
## Documentation
127-
128-
| Guide | Description |
129-
|-------|-------------|
130-
| [Docker Quickstart](./docs/docker-quickstart.md) | Get running in 5 minutes |
131-
| [Deployment](./docs/deployment.md) | Production deployment guide |
132-
| [MCP Setup](./docs/mcp-setup.md) | Claude Desktop integration |
133-
| [Docker Troubleshooting](./docs/docker-troubleshooting.md) | Common issues and fixes |
138+
- [Docker Quickstart](./docs/docker-quickstart.md) — Running in 5 minutes
139+
- [Deployment Guide](./docs/deployment.md) — Production setup
140+
- [MCP Integration](./docs/mcp-setup.md) — Claude Desktop setup
141+
- [Troubleshooting](./docs/docker-troubleshooting.md) — Common fixes
134142

135143
## Contributing
136144

137-
We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
138-
139-
**Quick links:**
140-
- [Open Issues](https://github.com/OpenCodeIntel/opencodeintel/issues)
141-
- [Good First Issues](https://github.com/OpenCodeIntel/opencodeintel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
145+
We'd love your help. See [CONTRIBUTING.md](./CONTRIBUTING.md).
142146

143147
## License
144148

145-
MIT License - see [LICENSE](./LICENSE) for details.
149+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)