更新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 模式
## 隱私與安全
- 預設本地優先
- 僅在使用者觸發時連網
- 支援系統代理
- 預設本地優先:解析、儲存、專案操作均在本地完成
- 僅在使用者主動觸發時才存取網路
- 支援系統代理,適配企業網路環境
## 授權