更新Readme文件

This commit is contained in:
xintaofei
2026-03-17 15:50:28 +08:00
parent f517f4fcbb
commit db4ff9d1ae
10 changed files with 803 additions and 174 deletions

View File

@@ -2,6 +2,8 @@
[![Release](https://img.shields.io/github/v/release/xintaofei/codeg)](https://github.com/xintaofei/codeg/releases)
[![License](https://img.shields.io/github/license/xintaofei/codeg)](../../LICENSE)
[![Tauri](https://img.shields.io/badge/Tauri-2.x-24C8DB)](https://tauri.app/)
[![Next.js](https://img.shields.io/badge/Next.js-16-black)](https://nextjs.org/)
<p>
<a href="../../README.md">English</a> |
@@ -16,29 +18,29 @@
<a href="./README.ar.md">العربية</a>
</p>
CodegCode Generation是一个面向多 Agent 的企业级代码生成工作台。
Claude Code、Codex CLI、OpenCode、Gemini CLI 等本地 AI 编码代理统一到一个桌面应用中,支持会话聚合、并行 `git worktree` 开发、MCP/Skills 管理,以及 Git/文件/终端一体化工作流。
CodegCode Generation是一个企业级多 Agent 编码工作台。
将本地 AI 编码代理(Claude Code、Codex CLI、OpenCode、Gemini CLI
OpenClaw 等)统一到一个桌面应用中,支持会话聚合、并行 `git worktree`
开发、MCP/Skills 管理,以及集成的 Git/文件/终端工作流。
## 主界面
![Codeg Light](../images/main-light.png#gh-light-mode-only)
![Codeg Dark](../images/main-dark.png#gh-dark-mode-only)
## 会话平铺显示
![Codeg Light](../images/main2-light.png#gh-light-mode-only)
![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only)
> 当前版本`v0.1.x`(快速迭代中)
> 当前状态`v0.1.x`(快速迭代中,适合早期使用者
## 核心亮点
- 多 Agent 统一工作台
- 本地会话聚合与结构化展示
- 内置 `git worktree` 并行开发
- 同一项目中的多 Agent 统一工作台
- 本地会话解析与结构化渲染
- 内置 `git worktree` 并行开发流程
- MCP 管理(本地扫描 + 市场搜索/安装)
- Skills 管理(全局与项目级)
- 文件树、Diff、Git、提交、终端一体化
- 集成工程闭环(文件树、Diff、Git 变更、提交、终端
## 支持范围
@@ -50,46 +52,75 @@ CodegCode Generation是一个面向多 Agent 的企业级代码生成工
| Codex CLI | `$CODEX_HOME/sessions` | `~/.codex/sessions` | `%USERPROFILE%\\.codex\\sessions` |
| OpenCode | `$XDG_DATA_HOME/opencode/opencode.db` | `~/.local/share/opencode/opencode.db` | `%USERPROFILE%\\.local\\share\\opencode\\opencode.db` |
| Gemini CLI | `$GEMINI_CLI_HOME/.gemini` | `~/.gemini` | `%USERPROFILE%\\.gemini` |
| OpenClaw | — | `~/.openclaw/agents` | `%USERPROFILE%\\.openclaw\\agents` |
> 注意:环境变量的优先级高于默认路径。
### 2) ACP 实时会话
内置 20+ Agent 适配器如 Claude Code、Codex CLI、Gemini CLI、OpenCode、OpenClaw 等)。
内置注册表包含 20+ 适配器如 Claude Code、Codex CLI、
Gemini CLI、OpenCode、OpenClaw、GitHub Copilot、Cline、Qwen Code 等。
### 3) Skills 设置支持
### 3) Skills 设置支持
- 已支持:`Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw`
- 其他代理将持续补齐
- 更多适配器将持续补齐
### 4) MCP 目标应用
当前支持写入Claude Code、Codex、OpenCode。
当前可写入的目标:
- Claude Code
- Codex
- OpenCode
## 快速开始
### 环境要求
- Node.js `>=22`
- Node.js `>=22`(推荐)
- pnpm `>=10`
- Rust stable2021 edition
- Tauri 2 构建依赖
LinuxDebian/Ubuntu示例
```bash
sudo apt-get update
sudo apt-get install -y \
libwebkit2gtk-4.1-dev \
libayatana-appindicator3-dev \
librsvg2-dev \
patchelf
```
### 开发命令
```bash
pnpm install
# 完整桌面应用Tauri + Next.js
pnpm tauri dev
# 仅前端
pnpm dev
# 前端静态导出到 out/
pnpm build
# 桌面应用构建
pnpm tauri build
# Lint
pnpm eslint .
# 在 src-tauri/ 下执行
# Rust 检查(在 src-tauri/ 下执行
cargo check
cargo clippy
cargo build
```
## 架构概览
## 架构
```text
Next.js 16 (Static Export) + React 19
@@ -98,24 +129,27 @@ Next.js 16 (Static Export) + React 19
v
Tauri 2 Commands (Rust)
|- ACP Manager
|- Parsers
|- Git / File Tree / Terminal
|- Parsers (local session ingestion)
|- Git / File Tree / Terminal runtime
|- MCP marketplace + local config writer
|- SeaORM + SQLite
|
v
Local Filesystem / Local Agent Data / Git Repos
```
## 开发约束
- 前端静态导出(`output: "export"`
- 不使用动态路由(`[param]`),统一查询参数
- 前端参数 `camelCase`Rust 参数 `snake_case`
- TypeScript strict
- 前端使用静态导出(`output: "export"`
- 不使用 Next.js 动态路由(`[param]`),统一使用查询参数
- Tauri 命令参数:前端 `camelCase`Rust `snake_case`
- TypeScript strict 模式
## 隐私与安全
- 默认本地优先
- 仅在用户触发时访问网络
- 支持系统代理
- 默认本地优先:解析、存储、项目操作均在本地完成
- 仅在用户主动触发时访问网络
- 支持系统代理,适配企业网络环境
## 许可证