# codeFinder

**Repository Path**: 741852963/code-finder

## Basic Information

- **Project Name**: codeFinder
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-07
- **Last Updated**: 2026-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# codeFinder

> 本地优先的代码智能工具 — 将代码库解析为可查询的知识图谱

[![Go Version](https://img.shields.io/badge/Go-1.26+-00ADD8?style=flat&logo=go)](https://go.dev/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## ✨ 特性

- 🚀 **多线程并发索引** — worker pool 并行解析，单 DB writer 串行写入
- 📊 **实时进度条** — 10fps 刷新，显示文件数/符号数/速率
- 🔍 **中文检索** — FTS5 trigram 分词器，3 字符滑动窗口支持中日韩文子串匹配
- 🌐 **25+ 编程语言** — Go/Python/TypeScript/JavaScript/Rust/Java/C#/PHP/Ruby/C/C++/Swift/Kotlin 等
- 🔌 **10 个 MCP 工具** — search/context/trace/callers/callees/impact/node/explore/files/status
- 📡 **文件变更自动同步** — fsnotify 原生 OS 事件 + 500ms 防抖
- 💾 **纯 Go 实现** — 无 CGO 依赖，跨平台编译

## 🚀 快速开始

### 安装

```bash
go install codefinder/cmd/codefinder@latest
```

### 初始化项目

```bash
cd your-project
codefinder init . --index
```

### 搜索符号

```bash
codefinder query UserService --kind class
codefinder query "登录"  # 中文搜索
```

### 调用关系

```bash
codefinder callers NewParser
codefinder callees NewParser
codefinder impact NewParser --depth 3
```

### 启动 MCP 服务器

```bash
codefinder serve --mcp
```

## 🔧 MCP 配置

### Claude Code

```json
{
  "mcpServers": {
    "codefinder": {
      "type": "stdio",
      "command": "codefinder",
      "args": ["serve"]
    }
  }
}
```

### Cursor / Trae

```json
{
  "mcpServers": {
    "codefinder": {
      "command": "D:\\code\\codeFinder\\build\\codefinder-v1.0.0-windows-amd64.exe",
      "args": ["serve"]
    }
  }
}
```

## 📖 文档

- [架构设计](docs/architecture.md) — 系统架构、数据流、并发模型
- [使用手册](docs/usage.md) — 安装、初始化、查询、MCP 配置
- [MCP 工具文档](docs/mcp-tools.md) — 10 个工具的详细参数和示例
- [语言支持](docs/languages.md) — 25 种编程语言的符号提取能力

## 🏗️ 技术栈

| 组件 | 选择 | 说明 |
|------|------|------|
| tree-sitter | [gotreesitter](https://github.com/odvcencio/gotreesitter) | 纯 Go，内置 206 grammar |
| SQLite | [modernc.org/sqlite](https://gitlab.com/cznic/sqlite) | 纯 Go，内置 FTS5 |
| MCP | [mcp-go](https://github.com/mark3labs/mcp-go) | Go MCP SDK |
| CLI | [cobra](https://github.com/spf13/cobra) | Go CLI 框架 |

## 📄 许可证

MIT License