From 32fbafa1fe520bb6120d27c8fc8925b3c688efd8 Mon Sep 17 00:00:00 2001 From: xintaofei Date: Mon, 9 Mar 2026 12:18:10 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=E6=96=87=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 195 ++++++++++++------------------------ docs/readme/README.ar.md | 65 ++++++++++++ docs/readme/README.de.md | 66 ++++++++++++ docs/readme/README.es.md | 66 ++++++++++++ docs/readme/README.fr.md | 66 ++++++++++++ docs/readme/README.ja.md | 83 +++++++++++++++ docs/readme/README.ko.md | 74 ++++++++++++++ docs/readme/README.pt.md | 65 ++++++++++++ docs/readme/README.zh-CN.md | 115 +++++++++++++++++++++ docs/readme/README.zh-TW.md | 115 +++++++++++++++++++++ 10 files changed, 777 insertions(+), 133 deletions(-) create mode 100644 docs/readme/README.ar.md create mode 100644 docs/readme/README.de.md create mode 100644 docs/readme/README.es.md create mode 100644 docs/readme/README.fr.md create mode 100644 docs/readme/README.ja.md create mode 100644 docs/readme/README.ko.md create mode 100644 docs/readme/README.pt.md create mode 100644 docs/readme/README.zh-CN.md create mode 100644 docs/readme/README.zh-TW.md diff --git a/README.md b/README.md index 4881ff2..1c1f0fa 100644 --- a/README.md +++ b/README.md @@ -5,86 +5,79 @@ [![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/) -Codeg（Code Generation）是一个面向多 Agent 的企业级代码生成工作台。 -它把不同 AI 编码代理（Claude Code、Codex CLI、OpenCode、Gemini CLI 等）统一到一个桌面应用里，支持会话聚合、并行 worktree 开发、MCP 与 Skills 管理，以及 Git/文件/终端一体化操作。 +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) is an enterprise-grade multi-agent coding workspace. +It unifies local AI coding agents (Claude Code, Codex CLI, OpenCode, Gemini CLI, +etc.) in one desktop app with session aggregation, parallel `git worktree` +development, MCP/Skills management, and integrated Git/file/terminal workflows. ![Codeg Light](./docs/images/main-light.png#gh-light-mode-only) ![Codeg Dark](./docs/images/main-dark.png#gh-dark-mode-only) -> 当前版本：`v0.0.x`（快速迭代中，适合早期体验与共建） +> Current status: `v0.0.x` (fast iteration, suitable for early adopters) -## 项目定位 +## Highlights -Codeg 的目标不是“又一个聊天窗口”，而是： +- Unified multi-agent workspace in the same project +- Local session ingestion with structured rendering +- Parallel development with built-in `git worktree` flows +- MCP management (local scan + registry search/install) +- Skills management (global and project scope) +- Integrated engineering loop (file tree, diff, git changes, commit, terminal) -- 面向真实研发场景的企业级代码生成工作台 -- 统一多代理协作入口 -- 支持多分支 / worktree 并发任务开发 -- 在单个项目上下文中聚合会话、变更、提交与执行链路 -- 逐步演进为稳定高效的 Agent Code Generation Workspace +## Supported Scope -## 核心亮点 +### 1) Session Ingestion (historical sessions) -- 多 Agent 统一工作台：同一项目内可同时使用不同代理并行对话 -- 本地会话聚合：导入并查看本机历史会话，统一结构化渲染（消息、工具调用、Token、上下文窗口） -- Worktree 并发开发：内置 `git worktree` 流程，支持多窗口并行任务 -- MCP 管理中心：扫描本地 MCP，支持官方 Registry 与 Smithery 搜索/安装 -- Skills 管理：支持全局 / 项目级 Skills 的查看、编辑、保存与删除 -- 工程操作闭环：文件树、Diff、Git 变更、Git Log、提交窗口、内置终端、项目命令 - -## 能力矩阵 - -| 模块 | 当前状态 | 说明 | -| --- | --- | --- | -| 本地会话解析与导入 | ✅ | 已支持 Claude Code / Codex / OpenCode / Gemini CLI | -| ACP 实时连接与对话 | ✅ | 已支持 20+ Agent 适配（npx/uvx/二进制） | -| Worktree 并发开发 | ✅ | 分支管理 + `git_worktree_add` + 多文件夹窗口 | -| MCP 管理 | ✅ | 本地扫描 + Marketplace 搜索/安装（Official + Smithery） | -| Skills 管理 | ✅ | 已支持 Claude/Codex/OpenCode/Gemini/OpenClaw | -| 文件工作区 | ✅ | 预览、编辑、Diff、保存、冲突对比 | - -## 支持范围 - -### 1) 会话解析（历史会话聚合） - -| Agent | 环境变量优先路径 | macOS / Linux 默认路径 | Windows 默认路径 | +| Agent | Environment Variable Path | macOS / Linux Default | Windows Default | | --- | --- | --- | --- | | Claude Code | `$CLAUDE_CONFIG_DIR/projects` | `~/.claude/projects` | `%USERPROFILE%\\.claude\\projects` | | 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` | -> 说明：以上默认路径按当前实现的回退逻辑整理，实际以环境变量为准。 +> Note: environment variables take precedence over fallback paths. -### 2) ACP 连接（实时 Agent 会话） +### 2) ACP real-time sessions -当前注册表内置： +Built-in registry includes 20+ adapters, such as Claude Code, Codex CLI, +Gemini CLI, OpenCode, OpenClaw, GitHub Copilot, Cline, Qwen Code, and others. -`Auggie, Autohand, Claude Code, Cline, Codebuddy Code, Codex CLI, Corust Agent, Factory Droid, Gemini CLI, GitHub Copilot, goose, Junie, Kimi CLI, Minion Code, Mistral Vibe, OpenClaw, OpenCode, Qoder CLI, Qwen Code, Stakpak` +### 3) Skills settings support -### 3) Skills 设置页支持 +- Supported: `Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw` +- More adapters will be added incrementally -- 已支持：`Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw` -- 其他代理：后续逐步补齐 +### 4) MCP target apps -### 4) MCP 目标应用 - -当前可写入配置： +Current writable targets: - Claude Code - Codex - OpenCode -## 快速开始 +## Quick Start -### 环境要求 +### Requirements -- Node.js `>=22`（推荐） +- Node.js `>=22` (recommended) - pnpm `>=10` -- Rust stable（2021 edition） -- Tauri 2 构建依赖（参考官方文档） +- Rust stable (2021 edition) +- Tauri 2 build dependencies -Linux（Debian/Ubuntu）常见依赖示例： +Linux (Debian/Ubuntu) example: ```bash sudo apt-get update @@ -95,44 +88,33 @@ sudo apt-get install -y \ patchelf ``` -### 安装与开发 +### Development ```bash pnpm install -# 启动完整桌面应用（Tauri + Next.js） +# Full desktop app (Tauri + Next.js) pnpm tauri dev -# 仅启动前端 +# Frontend only pnpm dev -# 前端构建（静态导出到 out/） +# Frontend static export to out/ pnpm build -# 构建桌面应用 +# Desktop build pnpm tauri build # Lint -pnpm lint . +pnpm eslint . -# Rust 检查（在 src-tauri/ 目录） +# Rust checks (run in src-tauri/) cargo check cargo clippy cargo build ``` -> 当前仓库尚未配置完整自动化测试框架（已有部分 Rust 单元测试）。 - -## 使用流程（建议） - -1. 在欢迎页打开本地目录，或 Clone 仓库。 -2. 进入 `Settings > Agents`，执行 Preflight、安装/配置代理。 -3. 在分支菜单创建分支或 Worktree，启动并行任务窗口。 -4. 新建会话并选择 Agent 开始编码。 -5. 在右侧面板查看会话文件改动、Git Changes、Git Log。 -6. 使用提交窗口完成选择文件、编辑提交信息与提交。 - -## 架构概览 +## Architecture ```text Next.js 16 (Static Export) + React 19 @@ -140,81 +122,28 @@ Next.js 16 (Static Export) + React 19 | invoke() v Tauri 2 Commands (Rust) - |- ACP Manager (agent lifecycle, streaming events, permissions) + |- ACP Manager |- Parsers (local session ingestion) |- Git / File Tree / Terminal runtime |- MCP marketplace + local config writer - |- SeaORM + SQLite (folders, conversations, settings) + |- SeaORM + SQLite | v Local Filesystem / Local Agent Data / Git Repos ``` -## 目录结构 +## Constraints -```text -src/ # Next.js 前端 - app/ # 页面与布局（静态导出模式） - components/ # 业务组件 + UI 组件 - contexts/ # 全局状态（会话、终端、工作区等） - lib/ # Tauri 调用封装、类型与工具 +- Frontend uses static export (`output: "export"`) +- No Next.js dynamic routes (`[param]`); use query params instead +- Tauri command params: frontend `camelCase`, Rust `snake_case` +- TypeScript strict mode -src-tauri/src/ # Rust 后端 - acp/ # Agent Connection Protocol 连接管理 - commands/ # 暴露给前端的 Tauri 命令 - parsers/ # 各代理会话解析器 - db/ # SQLite/SeaORM 与迁移 - terminal/ # PTY 终端管理 - network/ # 代理等网络设置 -``` +## Privacy & Security -## 开发约束 - -- 前端为静态导出模式（`next.config.ts` 中 `output: "export"`） -- 不使用 Next.js 动态路由（`[param]`），统一使用查询参数 -- Tauri 命令参数：前端 `camelCase`，Rust 端 `snake_case` -- TypeScript 严格模式（`strict` + noUnused） - -## 本地数据存储 - -- 应用数据库：`appDataDir/codeg.db`（SQLite + WAL） -- 会话原始数据：直接读取各 Agent 本地目录/文件，不做云端中转 -- 可导入会话：按“支持范围”中的路径规则扫描并写入本地数据库索引 - -## 产品路线图 - -### Near-term - -- 会话解析扩展到更多代理格式（统一抽象与插件化注册） -- MCP 安装管理（版本锁定、配置模板、环境校验） -- Skills 模板中心（可复用模板、项目级分发） - -### Mid-term - -- 多 Agent 协同编排（任务拆分、角色分工、结果合并） -- Worktree 任务面板（任务状态、上下游依赖、可视化流转） -- 团队级配置同步（Agent/MCP/Skills 配置分发） - -### Long-term - -- 插件化扩展机制（Parser / MCP / Skills 生态） -- 指标看板增强（Token/成本/时延/成功率） -- 组织级知识沉淀：会话资产化、检索、复盘与最佳实践沉淀 - -## 隐私与安全 - -- 默认以本地数据为主：会话解析、数据库与项目操作均在本机执行 -- 仅在你主动使用时访问网络（如 Agent 安装、MCP 市场搜索、Git 远程操作） -- 支持系统代理配置，便于企业网络环境接入 - -## 贡献 - -欢迎通过 Issue / PR 共建，建议优先从以下方向参与： - -- 新代理会话解析器 -- MCP 兼容层与配置适配 -- Worktree 并行开发体验优化 -- 会话可视化与指标面板优化 +- Local-first by default for parsing, storage, and project operations +- Network access happens only on user-triggered actions +- System proxy support for enterprise environments ## License diff --git a/docs/readme/README.ar.md b/docs/readme/README.ar.md new file mode 100644 index 0000000..8578246 --- /dev/null +++ b/docs/readme/README.ar.md @@ -0,0 +1,65 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) هو مساحة عمل مؤسسية لتوليد الشفرة باستخدام عدة +وكلاء Agent. +يوحّد الوكلاء المحليين مثل Claude Code وCodex CLI وOpenCode وGemini CLI داخل +تطبيق سطح مكتب واحد، مع تجميع الجلسات، وتطوير متوازي عبر `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) + +> الإصدار الحالي: `v0.0.x` (تطوير سريع) + +## أبرز المزايا + +- مساحة عمل موحّدة لعدة Agent +- تجميع محلي للجلسات مع عرض منظّم +- تطوير متوازي باستخدام `git worktree` +- إدارة MCP (فحص محلي + بحث/تثبيت) +- إدارة Skills (عام وعلى مستوى المشروع) + +## البدء السريع + +### المتطلبات + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- تبعيات بناء Tauri 2 + +### الأوامر + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# شغّل داخل src-tauri/ +cargo check +cargo clippy +cargo build +``` + +## الترخيص + +Apache-2.0. راجع `LICENSE`. diff --git a/docs/readme/README.de.md b/docs/readme/README.de.md new file mode 100644 index 0000000..e0050d5 --- /dev/null +++ b/docs/readme/README.de.md @@ -0,0 +1,66 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) ist ein Enterprise-Workspace für Code-Generierung mit +mehreren Agenten. +Lokale KI-Coding-Agenten wie Claude Code, Codex CLI, OpenCode und Gemini CLI +werden in einer Desktop-App zusammengeführt: mit Sitzungsaggregation, +paralleler `git worktree`-Entwicklung, MCP/Skills-Verwaltung und integriertem +Git/Datei/Terminal-Workflow. + +![Codeg Light](../images/main-light.png#gh-light-mode-only) +![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) + +> Aktuelle Version: `v0.0.x` (schnelle Iteration) + +## Highlights + +- Einheitlicher Multi-Agent-Workspace +- Lokale Sitzungsaggregation mit strukturierter Darstellung +- Parallele Entwicklung mit `git worktree` +- MCP-Verwaltung (lokaler Scan + Suche/Installation) +- Skills-Verwaltung (global und projektbezogen) + +## Schnellstart + +### Voraussetzungen + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- Tauri-2-Build-Abhängigkeiten + +### Befehle + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# In src-tauri/ ausführen +cargo check +cargo clippy +cargo build +``` + +## Lizenz + +Apache-2.0. Siehe `LICENSE`. diff --git a/docs/readme/README.es.md b/docs/readme/README.es.md new file mode 100644 index 0000000..5899441 --- /dev/null +++ b/docs/readme/README.es.md @@ -0,0 +1,66 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) es un espacio de trabajo empresarial para generación de +código con múltiples Agent. +Integra agentes locales como Claude Code, Codex CLI, OpenCode y Gemini CLI en +una sola aplicación de escritorio, con agregación de sesiones, desarrollo +paralelo con `git worktree`, gestión de MCP/Skills y flujo integrado de +Git/archivos/terminal. + +![Codeg Light](../images/main-light.png#gh-light-mode-only) +![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) + +> Versión actual: `v0.0.x` (iteración rápida) + +## Puntos clave + +- Espacio de trabajo unificado para múltiples Agent +- Agregación local de sesiones con vista estructurada +- Desarrollo paralelo con `git worktree` +- Gestión MCP (escaneo local + búsqueda/instalación) +- Gestión de Skills (global y por proyecto) + +## Inicio rápido + +### Requisitos + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- Dependencias de build para Tauri 2 + +### Comandos + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# Ejecutar en src-tauri/ +cargo check +cargo clippy +cargo build +``` + +## Licencia + +Apache-2.0. Ver `LICENSE`. diff --git a/docs/readme/README.fr.md b/docs/readme/README.fr.md new file mode 100644 index 0000000..95d624d --- /dev/null +++ b/docs/readme/README.fr.md @@ -0,0 +1,66 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) est un workspace de génération de code multi-Agent de +niveau entreprise. +Il unifie des agents locaux comme Claude Code, Codex CLI, OpenCode et Gemini +CLI dans une application desktop avec agrégation des sessions, développement +parallèle via `git worktree`, gestion MCP/Skills et workflow intégré +Git/fichiers/terminal. + +![Codeg Light](../images/main-light.png#gh-light-mode-only) +![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) + +> Version actuelle : `v0.0.x` (itération rapide) + +## Points forts + +- Workspace unifié pour plusieurs Agent +- Agrégation locale des sessions avec affichage structuré +- Développement parallèle avec `git worktree` +- Gestion MCP (scan local + recherche/installation) +- Gestion des Skills (global et projet) + +## Démarrage rapide + +### Prérequis + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- Dépendances de build Tauri 2 + +### Commandes + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# Exécuter dans src-tauri/ +cargo check +cargo clippy +cargo build +``` + +## Licence + +Apache-2.0. Voir `LICENSE`. diff --git a/docs/readme/README.ja.md b/docs/readme/README.ja.md new file mode 100644 index 0000000..f810288 --- /dev/null +++ b/docs/readme/README.ja.md @@ -0,0 +1,83 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg（Code Generation）は、複数 Agent 向けのエンタープライズ級コード生成ワークスペースです。 +Claude Code、Codex CLI、OpenCode、Gemini CLI などのローカル AI コーディング Agent を 1 つのデスクトップアプリに統合し、セッション集約、並列 `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) + +> 現在のバージョン: `v0.0.x`（高速に改善中） + +## 主な特長 + +- 同一プロジェクトでのマルチ Agent 統合ワークスペース +- ローカルセッションの集約と構造化表示 +- `git worktree` による並列開発 +- MCP 管理（ローカルスキャン + 検索/インストール） +- Skills 管理（グローバル/プロジェクト） +- ファイルツリー、Diff、Git、コミット、ターミナルの一体化 + +## 対応範囲 + +### 1) セッション取り込み（履歴） + +| Agent | 環境変数優先パス | macOS / Linux 既定 | Windows 既定 | +| --- | --- | --- | --- | +| Claude Code | `$CLAUDE_CONFIG_DIR/projects` | `~/.claude/projects` | `%USERPROFILE%\\.claude\\projects` | +| 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` | + +### 2) ACP リアルタイムセッション + +20 以上の Agent アダプターを内蔵（Claude Code、Codex CLI、Gemini CLI、OpenCode、OpenClaw など）。 + +### 3) Skills 設定対応 + +- 対応済み: `Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw` +- 他 Agent は順次追加予定 + +## クイックスタート + +### 要件 + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable（2021 edition） +- Tauri 2 のビルド依存 + +### 開発コマンド + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# src-tauri/ で実行 +cargo check +cargo clippy +cargo build +``` + +## ライセンス + +Apache-2.0。`LICENSE` を参照してください。 diff --git a/docs/readme/README.ko.md b/docs/readme/README.ko.md new file mode 100644 index 0000000..6ca9a37 --- /dev/null +++ b/docs/readme/README.ko.md @@ -0,0 +1,74 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg(Code Generation)는 멀티 Agent를 위한 엔터프라이즈급 코드 생성 워크스페이스입니다. +Claude Code, Codex CLI, OpenCode, Gemini CLI 등 로컬 AI 코딩 Agent를 하나의 데스크톱 앱으로 통합하여 세션 집계, 병렬 `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) + +> 현재 버전: `v0.0.x` (빠르게 개선 중) + +## 핵심 기능 + +- 하나의 프로젝트에서 멀티 Agent 통합 사용 +- 로컬 세션 집계 및 구조화 표시 +- 내장 `git worktree` 병렬 개발 +- MCP 관리(로컬 스캔 + 검색/설치) +- Skills 관리(전역/프로젝트) +- 파일 트리, Diff, Git, 커밋, 터미널 통합 + +## 지원 범위 + +### 1) 세션 수집(히스토리) + +| Agent | 환경 변수 우선 경로 | macOS / Linux 기본 경로 | Windows 기본 경로 | +| --- | --- | --- | --- | +| Claude Code | `$CLAUDE_CONFIG_DIR/projects` | `~/.claude/projects` | `%USERPROFILE%\\.claude\\projects` | +| 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` | + +## 빠른 시작 + +### 요구 사항 + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- Tauri 2 빌드 의존성 + +### 개발 명령 + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# src-tauri/ 에서 실행 +cargo check +cargo clippy +cargo build +``` + +## 라이선스 + +Apache-2.0. `LICENSE` 참고. diff --git a/docs/readme/README.pt.md b/docs/readme/README.pt.md new file mode 100644 index 0000000..8db0688 --- /dev/null +++ b/docs/readme/README.pt.md @@ -0,0 +1,65 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg (Code Generation) é um workspace empresarial para geração de código com +múltiplos Agent. +Ele unifica agentes locais como Claude Code, Codex CLI, OpenCode e Gemini CLI +em um único app desktop com agregação de sessões, desenvolvimento paralelo com +`git worktree`, gestão de MCP/Skills e fluxo integrado de Git/arquivos/terminal. + +![Codeg Light](../images/main-light.png#gh-light-mode-only) +![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) + +> Versão atual: `v0.0.x` (iteração rápida) + +## Destaques + +- Workspace unificado para múltiplos Agent +- Agregação local de sessões com visualização estruturada +- Desenvolvimento paralelo com `git worktree` +- Gestão de MCP (varredura local + busca/instalação) +- Gestão de Skills (global e por projeto) + +## Início rápido + +### Requisitos + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable (2021 edition) +- Dependências de build do Tauri 2 + +### Comandos + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# Executar em src-tauri/ +cargo check +cargo clippy +cargo build +``` + +## Licença + +Apache-2.0. Veja `LICENSE`. diff --git a/docs/readme/README.zh-CN.md b/docs/readme/README.zh-CN.md new file mode 100644 index 0000000..87a6d70 --- /dev/null +++ b/docs/readme/README.zh-CN.md @@ -0,0 +1,115 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg（Code Generation）是一个面向多 Agent 的企业级代码生成工作台。 +它把 Claude Code、Codex CLI、OpenCode、Gemini CLI 等本地 AI 编码代理统一到一个桌面应用中，支持会话聚合、并行 `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) + +> 当前版本：`v0.0.x`（快速迭代中） + +## 核心亮点 + +- 多 Agent 统一工作台 +- 本地会话聚合与结构化展示 +- 内置 `git worktree` 并行开发 +- MCP 管理（本地扫描 + 市场搜索/安装） +- Skills 管理（全局与项目级） +- 文件树、Diff、Git、提交、终端一体化 + +## 支持范围 + +### 1) 会话解析（历史会话） + +| Agent | 环境变量优先路径 | macOS / Linux 默认路径 | Windows 默认路径 | +| --- | --- | --- | --- | +| Claude Code | `$CLAUDE_CONFIG_DIR/projects` | `~/.claude/projects` | `%USERPROFILE%\\.claude\\projects` | +| 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` | + +### 2) ACP 实时会话 + +内置 20+ Agent 适配器（如 Claude Code、Codex CLI、Gemini CLI、OpenCode、OpenClaw 等）。 + +### 3) Skills 设置页支持 + +- 已支持：`Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw` +- 其他代理将持续补齐 + +### 4) MCP 目标应用 + +当前支持写入：Claude Code、Codex、OpenCode。 + +## 快速开始 + +### 环境要求 + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable（2021 edition） +- Tauri 2 构建依赖 + +### 开发命令 + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# 在 src-tauri/ 下执行 +cargo check +cargo clippy +cargo build +``` + +## 架构概览 + +```text +Next.js 16 (Static Export) + React 19 + | + | invoke() + v +Tauri 2 Commands (Rust) + |- ACP Manager + |- Parsers + |- Git / File Tree / Terminal + |- MCP marketplace + local config writer + |- SeaORM + SQLite +``` + +## 开发约束 + +- 前端静态导出（`output: "export"`） +- 不使用动态路由（`[param]`），统一查询参数 +- 前端参数 `camelCase`，Rust 参数 `snake_case` +- TypeScript strict + +## 隐私与安全 + +- 默认本地优先 +- 仅在用户触发时访问网络 +- 支持系统代理 + +## 许可证 + +Apache-2.0，详见 `LICENSE`。 diff --git a/docs/readme/README.zh-TW.md b/docs/readme/README.zh-TW.md new file mode 100644 index 0000000..bdc384b --- /dev/null +++ b/docs/readme/README.zh-TW.md @@ -0,0 +1,115 @@ +# Codeg + +[![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) + +

+ English | + 简体中文 | + 繁體中文 | + 日本語 | + 한국어 | + Español | + Deutsch | + Français | + Português | + العربية +

+ +Codeg（Code Generation）是面向多 Agent 的企業級程式碼生成工作台。 +它將 Claude Code、Codex CLI、OpenCode、Gemini CLI 等本地 AI 編碼代理整合到一個桌面應用，支援會話彙整、並行 `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) + +> 目前版本：`v0.0.x`（快速迭代中） + +## 核心亮點 + +- 多 Agent 統一工作台 +- 本地會話彙整與結構化顯示 +- 內建 `git worktree` 並行開發 +- MCP 管理（本地掃描 + 市場搜尋/安裝） +- Skills 管理（全域與專案級） +- 檔案樹、Diff、Git、提交、終端一體化 + +## 支援範圍 + +### 1) 會話解析（歷史會話） + +| Agent | 環境變數優先路徑 | macOS / Linux 預設路徑 | Windows 預設路徑 | +| --- | --- | --- | --- | +| Claude Code | `$CLAUDE_CONFIG_DIR/projects` | `~/.claude/projects` | `%USERPROFILE%\\.claude\\projects` | +| 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` | + +### 2) ACP 即時會話 + +內建 20+ Agent 適配器（如 Claude Code、Codex CLI、Gemini CLI、OpenCode、OpenClaw 等）。 + +### 3) Skills 設定頁支援 + +- 已支援：`Claude Code / Codex / OpenCode / Gemini CLI / OpenClaw` +- 其他代理持續補齊 + +### 4) MCP 目標應用 + +目前支援寫入：Claude Code、Codex、OpenCode。 + +## 快速開始 + +### 環境需求 + +- Node.js `>=22` +- pnpm `>=10` +- Rust stable（2021 edition） +- Tauri 2 建置依賴 + +### 開發命令 + +```bash +pnpm install +pnpm tauri dev +pnpm dev +pnpm build +pnpm tauri build +pnpm eslint . + +# 在 src-tauri/ 下執行 +cargo check +cargo clippy +cargo build +``` + +## 架構概覽 + +```text +Next.js 16 (Static Export) + React 19 + | + | invoke() + v +Tauri 2 Commands (Rust) + |- ACP Manager + |- Parsers + |- Git / File Tree / Terminal + |- MCP marketplace + local config writer + |- SeaORM + SQLite +``` + +## 開發約束 + +- 前端靜態匯出（`output: "export"`） +- 不使用動態路由（`[param]`），改用查詢參數 +- 前端參數 `camelCase`，Rust 參數 `snake_case` +- TypeScript strict + +## 隱私與安全 + +- 預設本地優先 +- 僅在使用者觸發時連網 +- 支援系統代理 + +## 授權 + +Apache-2.0，詳見 `LICENSE`。