# Brace

**Repository Path**: Tngtion/brace

## Basic Information

- **Project Name**: Brace
- **Description**: 一个模型训练数据集编辑插件。一个数据集仓库。样本仓库。拉取样本的客户端命令行。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://gitee.com/tngtion
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 4
- **Created**: 2026-05-30
- **Last Updated**: 2026-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 大模型训练, 训练数据集, 样本仓库, 数据集编辑插件

## README

# 铸语系统（Brace）

大模型训练数据集管理平台，包含数据仓库、CLI 工具、后端服务和前端界面。

## 系统架构

```
brace/
├── brace-hub-data/     # 数据仓库（纯数据）
├── brace-cli/          # CLI 工具（Go）
├── brace-hub/          # 后端服务（Go + Gin）
├── brace-hub-web/      # 公开前端（Vue 3.5）
├── brace-hub-admin/    # 管理后台（Vue 3.5）
├── build/              # 预编译文件
└── docker-compose.yml  # Docker 部署
```

## 快速开始

### Docker 部署（推荐）

```bash
# 1. 复制环境变量
cp .env.example .env

# 2. 修改 JWT 密钥
vim .env

# 3. 启动服务
make up

# 4. 访问
# 公开前端: http://localhost:3000
# 管理后台: http://localhost:3001
# API: http://localhost:8080
```

### 本地开发

```bash
# 后端
cd brace-hub
go run ./cmd/server

# 公开前端
cd brace-hub-web
npm install
npm run dev

# 管理后台
cd brace-hub-admin
npm install
npm run dev
```

## 功能说明

### CLI 工具

```bash
# 安装（Mac）
cp build/brace-darwin-arm64 /usr/local/bin/brace

# 使用
brace init                    # 初始化 bracefile
brace config set source <url> # 设置数据源
brace search 充电              # 搜索样本/模板
brace pull 充电/template_充电   # 拉取数据
brace build                   # 构建数据集
brace build --preview         # 预览模式
brace info                    # 查看配置
brace list                    # 列出已拉取数据
```

### API 接口

| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /api/v1/auth/register | 用户注册 |
| POST | /api/v1/auth/login | 用户登录 |
| GET | /api/v1/search | 搜索 |
| GET | /api/v1/scenes | 场景列表 |
| GET | /api/v1/scenes/:name | 场景详情 |
| GET | /api/v1/samples/:id | 样本详情 |
| GET | /api/v1/templates/:id | 模板详情 |
| POST | /api/v1/download/prepare | 准备下载 |
| POST | /api/v1/download/command | 下载命令 |

### 管理后台

| 功能 | 说明 |
|------|------|
| Dashboard | 统计信息 |
| 用户管理 | 审核/封禁 |
| 场景管理 | 场景列表 |
| 操作日志 | 管理员操作记录 |

## 技术栈

| 组件 | 技术 |
|------|------|
| CLI | Go 1.26+ / Cobra |
| 后端 | Go / Gin / GORM / SQLite |
| 前端 | Vue 3.5 / TypeScript / Element Plus |
| 部署 | Docker / docker-compose |

## 开发规范

- 每个 commit 只做一件事
- 测试和实现一起提交
- commit message: `feat/fix/test/docs: 简述`
- 每个模块必须有单元测试

## 项目状态

| 项目 | 状态 | 测试 |
|------|------|------|
| brace-hub-data | ✅ 完成 | - |
| brace-cli | ✅ 完成 | 51 测试 |
| brace-hub | ✅ 完成 | 33 测试 |
| brace-hub-web | ✅ 完成 | - |
| brace-hub-admin | ✅ 完成 | - |
| Docker | ✅ 完成 | - |

## 许可证

MIT License