Skip to content

README.md

Latest commit

 

History

History
353 lines (253 loc) · 9.44 KB

README.md

File metadata and controls

353 lines (253 loc) · 9.44 KB

coding-tool-x

面向 Claude Code、Codex CLI、Gemini CLI、OpenCode 的统一增强控制台
Web UI + CLI + 多平台代理 + 配置托管 + 工作区编排 + 分析面板

Node.js License Platforms

Home Preview

coding-tool-x 把多个 Coding CLI 的常用管理能力收拢到一套界面里: 会话查看、渠道代理、配置同步、工作区组织、MCP / Skills / Commands / Agents / Plugins 管理、OAuth 凭证托管、通知设置、统计分析和配置导入导出。

如果你同时在用 Claude Code、Codex CLI、Gemini CLI、OpenCode，这个项目的目标就是把这些分散在不同目录、不同配置文件、不同命令里的日常操作，尽量放回一个统一入口。

适合做什么

  • 统一查看四个平台的项目和会话
  • 管理多渠道代理、测速、模型探测和健康状态
  • 集中托管 Prompts、Skills、Agents、Commands、MCP、Plugins 等常用配置项
  • 为多项目创建工作区，必要时自动创建 Git worktree
  • 统一查看请求量、Token、费用趋势与实时日志
  • 导入导出整套配置，包含原生配置快照

功能概览

会话与项目

  • 支持 Claude、Codex、Gemini、OpenCode 四个平台的项目与会话列表
  • 支持项目排序、项目搜索、会话排序、会话搜索
  • 支持最近会话、收藏、别名、聊天记录查看
  • 支持新建会话、删除会话、复制启动命令
  • Claude / Codex / Gemini 会话支持格式转换
  • 支持将 Claude / Codex / Gemini 请求转换为 OpenCode 网关请求

多渠道代理

  • 四个平台均支持独立代理端口和独立渠道配置
  • 支持渠道增删改查、启用 / 停用、排序、权重、并发限制
  • 支持速度测试、模型可用性探测、健康检查与故障冻结
  • 支持模型重定向和默认测速模型配置
  • Web UI 与 CLI 都可查看代理状态和日志

配置与托管

  • 集中存储在 ~/.cc-tool
  • 保留并同步各平台原生配置目录，而不是替代原生用法
  • 支持 Prompts 预设管理，并同步到各平台对应提示文件
  • 支持 Skills、Agents、Commands、Plugins 的中心托管与按支持的平台启停
  • 支持 MCP 服务器配置、预设、连通性测试和多平台写入
  • 支持 OAuth 凭证池管理与回写原生配置
  • 支持 ZIP / JSON 配置导入导出

工作区与运维

  • 支持多项目工作区
  • 支持为 Git 仓库创建 worktree
  • 支持配置模板，将提示词、技能、命令、代理、MCP、插件组合成一套模板
  • 支持 Dashboard、Analytics、日志、统计导出、环境诊断
  • 支持面板访问密码
  • LAN 模式默认禁止远程写操作，可按需开启

通知

  • 支持 Claude、Codex、Gemini、OpenCode 的任务完成通知托管
  • 支持系统通知和弹窗模式
  • 支持飞书机器人 Webhook 通知

能力矩阵

能力 Claude Codex Gemini OpenCode
项目 / 会话查看 支持 支持 支持 支持
渠道 / 代理管理 支持 支持 支持 支持
Prompts 预设同步 支持 支持 支持 支持
Skills 管理 支持 支持 支持 支持
Commands 管理 支持 - - 支持
Agents 管理 支持 支持 - 支持
Plugins 管理 支持 - - 支持
OAuth 凭证托管 支持 支持 支持 支持
通知托管 支持 支持 支持 支持
请求 / 会话统计 支持 支持 支持 支持

补充说明:

  • Codex Agents 目前仅支持用户级代理
  • OpenCode 会话读取依赖本机 sqlite3
  • Commands 的直接 CRUD 当前面向 Claude / OpenCode

安装

全局安装

npm install -g coding-tool-x

国内镜像

npm install -g coding-tool-x --registry=https://registry.npmmirror.com

从源码运行

git clone https://github.com/ZeaoZhang/coding-tool.git
cd coding-tool
npm install
npm run build:web
npm link

环境要求

  • Node.js >= 14.0.0
  • 建议至少运行过一次目标 CLI，以便生成原生配置目录
  • 如需读取 OpenCode 会话，请确保系统里有可用的 sqlite3

快速开始

推荐方式

ctx start
ctx status

启动后默认访问:

  • Web UI: http://localhost:19999

前台运行

ctx ui

开启局域网访问

ctx ui --host

LAN 模式说明:

  • 服务会监听 0.0.0.0
  • 默认只允许本机执行写操作
  • 如确需允许远程写操作，可显式设置:
CC_TOOL_ALLOW_REMOTE_WRITE=true ctx ui --host

单独控制平台代理

ctx claude start
ctx codex start
ctx gemini start
ctx opencode start

常用命令

服务

命令 说明
ctx start 后台启动整套服务
ctx stop 停止后台服务
ctx restart 重启后台服务
ctx status 查看后台服务状态
ctx ui 前台启动 Web UI
ctx ui start 后台启动 Web UI
ctx ui stop 停止后台 Web UI
ctx ui restart 重启后台 Web UI

平台代理

命令 说明
ctx claude start|stop|restart|status Claude 代理管理
ctx codex start|stop|restart|status Codex 代理管理
ctx gemini start|stop|restart|status Gemini 代理管理
ctx opencode start|stop|restart|status OpenCode 代理管理

日志与统计

命令 说明
ctx logs 查看所有日志
ctx logs ui 查看 UI 日志
ctx logs claude 查看 Claude 代理日志
ctx logs --follow 实时追踪日志
ctx logs --lines 100 查看最近 100 行
ctx logs --clear 清空日志
ctx stats 查看总体统计
ctx stats claude 查看单个平台统计
ctx stats export 导出统计数据
ctx doctor 运行环境诊断

其他

命令 说明
ctx update 检查并更新版本
ctx port 修改默认端口
ctx reset 重置 ~/.cc-tool 配置
ctx security reset 关闭面板访问密码
ctx plugin list 查看已安装插件
ctx plugin install <git-url> 从 Git 安装插件

兼容说明:

  • ctx proxy start|stop|status 仍保留为旧入口
  • 新用法更推荐 ctx claude ...、ctx codex ...、ctx gemini ...、ctx opencode ...

Web UI 主要模块

Home / Dashboard

  • 四个平台并列状态卡
  • 支持拖拽调整平台顺序
  • 展示代理状态、今日请求、Token、费用、项目数、会话数

项目与会话

  • 项目列表、会话列表
  • 全局搜索和项目内搜索
  • 聊天历史查看
  • 收藏、别名、删除、复制启动命令，部分平台支持 Fork

配置管理

  • Prompts
  • MCP
  • Skills
  • Commands
  • Agents
  • Plugins
  • OAuth Credentials
  • Config Export / Import

工作区与模板

  • Workspaces
  • Config Templates
  • Git worktree 组织

Analytics

  • 多平台统计汇总
  • 模型 / 渠道 / 工具维度分析
  • 时间范围筛选
  • CSV / JSON 导出

默认端口

服务 默认端口
Web UI / WebSocket 19999
Claude Proxy 20088
Codex Proxy 20089
Gemini Proxy 20090
OpenCode Proxy 20091

可通过 ctx port 修改。

数据目录

中央目录

默认位于:

~/.cc-tool

常见内容:

  • config/: 主配置、Prompts、MCP、OAuth、工作区、模板等
  • configs/: 托管的 skills / commands / agents / plugins
  • storage/: 渠道、缓存、统计、内部运行数据
  • logs/: 服务与代理日志
  • plugins/: 插件安装与插件配置

原生配置目录

项目会继续读写各平台原生配置:

  • Claude: ~/.claude
  • Codex: ${CODEX_HOME:-~/.codex}
  • Gemini: ~/.gemini
  • OpenCode:
    • 配置: ~/.config/opencode
    • 数据: ~/.local/share/opencode

开发

安装依赖

npm install

启动前端开发服务器

npm run dev:web

启动后端开发模式

npm run dev:server

构建前端

npm run build:web

运行测试

npm test

当前仓库内置了基础命令、API 一致性、Codex Agents、Skills Provider、插件市场缓存等相关回归测试。

已知说明

  • ctx ui --host 开启 LAN 访问后，默认不会允许远程写操作，这是安全保护行为
  • OpenCode 部分能力依赖本机可访问的 OpenCode 配置目录和 sqlite3
  • 配置导出包可能包含 API Key、Webhook、OAuth 等敏感信息，请妥善保管

相关文档

致谢

特别感谢 CooperJiang/coding-tool 提供的项目基础。coding-tool-x 在原有能力之上持续扩展，补齐了多平台支持、配置同步、扩展管理、工作区编排与分析面板等增强能力；没有上游项目打下的基础，这个增强型分支也很难持续演进。

也感谢所有在使用、反馈、测试和持续完善这个分支过程中提供帮助的贡献者与用户。正是这些真实场景下的需求、问题和建议，让这个项目逐步从单一工具发展成更完整的 Coding CLI 工作台。

License

MIT