# kb

**Repository Path**: embaobao/kb

## Basic Information

- **Project Name**: kb
- **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-04-04
- **Last Updated**: 2026-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CodeKB

> AI 代码知识库生成工具 - 拉取 GitLab 仓库生成 AI 可读的项目知识库

## 功能特性

- 🤖 **AI 大纲生成** - 使用 LLM 分析项目结构，生成功能描述
- 📦 **多仓库支持** - 支持同时管理多个 GitLab 仓库
- 🌿 **分支管理** - 针对不同分支生成独立知识库
- ✂️ **代码切片** - 使用 Repomix 生成 AI 友好的代码表示
- 🔍 **语义搜索** - 基于向量数据库的语义搜索能力
- 📝 **文档输出** - 生成 Markdown 格式的项目文档

## 快速开始

### 1. 安装依赖

```bash
cd /workspace/ai/codekb
yarn install
```

### 2. 配置项目

复制并编辑配置文件：

```bash
cp config/projects.yaml config/projects.yaml.bak
# 编辑 config/projects.yaml 填入你的配置
```

或使用环境变量：

```bash
# GitLab 配置
export GITLAB_URL=https://gitlab.example.com
export GITLAB_TOKEN=glpat-xxxxx

# 火山引擎 CodePlan 配置
export CODEPLAN_BASE_URL=https://ark.cn-beijing.volces.com/api/v3
export CODEPLAN_API_KEY=sk-xxxxx
export CODEPLAN_MODEL=doubao-pro-32k
```

### 3. 同步项目

```bash
# 同步所有项目
yarn kb sync

# 同步指定项目
yarn kb sync extension-ai

# 强制重新克隆
yarn kb sync extension-ai --force
```

### 4. 搜索代码

```bash
# 搜索代码
yarn kb search "如何实现表单验证"

# 指定项目和分支
yarn kb search "表单验证" --project extension-ai --branch main
```

### 5. 查看项目列表

```bash
# 列出所有项目
yarn kb list

# 查看项目详情
yarn kb info extension-ai
```

## 命令列表

| 命令 | 说明 |
|-----|------|
| `kb sync [project]` | 同步项目知识库 |
| `kb search <query>` | 搜索代码 |
| `kb list` | 列出所有项目 |
| `kb info <project>` | 查看项目详情 |

## 配置说明

配置文件 `config/projects.yaml`：

```yaml
gitlab:
  baseUrl: "${GITLAB_URL}"
  token: "${GITLAB_TOKEN}"
  workspace: "group-name"

llm:
  baseUrl: "${CODEPLAN_BASE_URL}"
  apiKey: "${CODEPLAN_API_KEY}"
  model: "doubao-pro-32k"

projects:
  - name: extension-ai
    repo: "fe/extension-ai"
    branches:
      - main
      - develop
```

## 技术架构

```
CodeKB
├── src/
│   ├── config/          # 配置管理
│   ├── gitlab/          # GitLab 客户端
│   ├── llm/             # LLM 客户端 (火山引擎 CodePlan)
│   ├── analyzer/        # 项目分析 (目录树 + 大纲)
│   ├── splitter/        # 代码切片 (Repomix)
│   ├── vector/          # 向量存储 (LanceDB)
│   ├── output/          # Markdown 输出
│   └── cli/             # CLI 工具
├── config/              # 配置文件
├── output/              # 输出目录
└── openspec/            # OpenSpec 变更记录
```

## 开发指南

```bash
# 开发模式
yarn dev

# 构建
yarn build

# 类型检查
yarn typecheck
```

## 许可证

MIT