# Catalyst

**Repository Path**: SlayerNux_admin/Catalyst

## Basic Information

- **Project Name**: Catalyst
- **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-02-11
- **Last Updated**: 2026-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Catalyst

Self-Evolving Code Assistant - 基于Kotlin/Native的自进化AI代码助手系统

## 项目信息

- **项目名**: Catalyst（催化剂）
- **目标**: Self-Evolving Code Assistant Bot
- **语言**: Kotlin
- **编译方式**: Kotlin/Native
- **运行平台**: Ubuntu
- **架构**:
  - 核心: Bot Framework（Bot Core + SOUL System）
  - 编排: ReCap自进化引擎
  - 能力: 代码评审、架构设计、单元测试生成等
- **短期目标**: AI Code Assistant v1.0
- **长期目标**: Self-Evolving AI Bot Platform

## 快速开始

### 前置要求

- Kotlin 1.9.22+
- Gradle 8.0+
- Ubuntu 20.04+ (or similar Linux distribution)

### 配置

1. 复制密钥配置文件：
```bash
cp config/secrets.properties.example secrets.properties
```

2. 编辑 `secrets.properties`，填入实际的LLM连接密钥

### 编译

```bash
./gradlew build
```

### 运行

```bash
./gradlew runDebugExecutableLinuxX64
```

## 项目结构

```
Catalyst/
├── src/
│   ├── commonMain/kotlin/      # 公共代码
│   │   ├── demo/recap/         # ReCap引擎核心
│   │   ├── demo/recap/bot/     # Bot框架
│   │   ├── demo/recap/skills/  # 技能实现
│   │   └── demo/recap/tools/   # 工具集
│   ├── commonTest/kotlin/      # 公共测试
│   └── linuxX64Main/           # Linux特定实现
├── docs/
│   ├── INDEX.md                # 文档导航
│   ├── QUICK_START.md          # 快速开始
│   ├── ARCHITECTURE/
│   │   ├── CONSTRAINTS.md      # 项目约束
│   │   ├── CURRENT_STATUS.md   # 项目状态
│   │   └── ...
│   ├── PHASES/                 # 阶段完成报告
│   └── SKILLS/                 # 技能定义
├── config/
│   └── secrets.properties.example
├── build.gradle.kts
├── settings.gradle.kts
├── CLAUDE.md                   # AI开发规范
└── README.md                   # 项目首页
```

## 项目约束

详见 [CONSTRAINTS.md](docs/ARCHITECTURE/CONSTRAINTS.md)

### 关键点

1. **编排算法**: 必须使用ReCap，不使用现成框架
2. **测试**: 每个功能模块需充分的单元测试
3. **文档**: 复杂任务需在 `docs/plan/<任务名>/` 下产出规划文档
4. **语言**:
   - 代码注释和文档: 中文
   - 提交消息: 英文
5. **优先级**: 先集成shell功能

## 开发指南

### 添加新功能

对于复杂功能，请先：
1. 在 `docs/plan/<功能名>/` 下创建规划文档
2. 完成设计评审
3. 编写单元测试
4. 实现功能代码

### 提交规范

```
feat: Add code review skill to Catalyst

- Implement CodeReviewSkill with violation detection
- Add unit tests for code pattern analysis
- Document design in docs/SKILLS/CodeReviewSkill.md

Co-Authored-By: Claude
```

## 许可证

MIT