Skip to content

Commit 55abba9

Browse files
committed
docs(readme): add Chinese translation for README
The README file now includes a Chinese translation to make the project more accessible to Chinese-speaking users. A new README.zh-CN.md file has been added with complete Chinese documentation. The main README.md now includes language selection links at the top for easy navigation between English and Chinese versions.
1 parent 59de0a9 commit 55abba9

2 files changed

Lines changed: 178 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# AgentX
22

3+
English | [Chinese](README.zh-CN.md)
4+
35
AgentX stands for Agent eXtension: A unified CLI tool for managing **MCP (Model Context Protocol) Servers** and **Skills** across multiple AI coding agents.
46

57
## Overview

README.zh-CN.md

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# AgentX
2+
3+
中文 | [English](README.md)
4+
5+
AgentX 即 Agent eXtension:一个统一的 CLI 工具,用于在多个 AI 编程代理之间管理 **MCP(Model Context Protocol)服务器****技能(Skills)**
6+
7+
## 概览
8+
9+
AgentX 简化了在主流 AI 编程工具中安装、管理与监控 MCP 服务器与技能的流程:
10+
11+
- **Claude Code**
12+
- **Codex**
13+
- **Cursor**
14+
- **Gemini CLI**
15+
- **OpenCode**
16+
17+
它同时提供命令行接口与交互式终端 UI(TUI),便于统一配置管理。
18+
19+
## 特性
20+
21+
### MCP 服务器管理
22+
- 在多个代理之间安装/移除 MCP 服务器
23+
- 检查安装状态
24+
- 一键安装到所有支持的代理
25+
- 支持的 MCP 服务器:
26+
- **Playwright** - 浏览器自动化能力
27+
- **Context7** - 库文档访问
28+
29+
### Claude Code 与 Codex 技能管理
30+
- 从本地路径或 Git 仓库安装技能
31+
- 支持技能目录(包含 `SKILL.md`);Claude Code 还支持命令文件(`.md`
32+
- 支持带 tree 路径的 GitHub URL
33+
- 支持个人与项目级作用域
34+
- 技能健康检查与验证
35+
36+
### 交互式 TUI
37+
- 三个主标签:MCP Servers、Skills、Code Agents
38+
- 可视化矩阵展示各代理的 MCP 安装状态
39+
- 键盘快捷键快速操作
40+
- 实时状态刷新
41+
42+
## 安装
43+
44+
### 1. Homebrew(macOS/Linux)
45+
46+
```bash
47+
# 添加 tap(指向本仓库)
48+
brew tap agentsdance/agentx https://github.com/agentsdance/agentx.git
49+
50+
# 安装 agentx
51+
brew install agentx
52+
53+
# 升级到最新版本
54+
brew upgrade agentx
55+
```
56+
57+
### 2. 下载二进制
58+
59+
[GitHub Releases](https://github.com/agentsdance/agentx/releases) 下载最新版本。
60+
61+
### 3. Go Install
62+
63+
```bash
64+
go install github.com/agentsdance/agentx@latest
65+
```
66+
67+
### 4. 从源码构建
68+
69+
```bash
70+
# 克隆仓库
71+
git clone https://github.com/agentsdance/agentx.git
72+
cd agentx
73+
74+
# 构建
75+
make build
76+
77+
# 安装到 /usr/local/bin(可通过 PREFIX 环境变量自定义)
78+
make install
79+
```
80+
81+
### 前置条件
82+
83+
- **Go 1.25+**(构建所需)
84+
- **Node.js with npm**(MCP 服务器通过 npx 运行)
85+
- **Git**(克隆技能仓库)
86+
87+
## 使用
88+
89+
### 交互模式
90+
91+
启动交互式 TUI:
92+
93+
```bash
94+
agentx
95+
```
96+
97+
键盘快捷键:
98+
- `Tab` / `Shift+Tab` - 切换标签
99+
- `` / `` - 导航条目
100+
- `Enter` - 选择/切换
101+
- `q` / `Ctrl+C` - 退出
102+
103+
### CLI 命令
104+
105+
![](./tui1.png)
106+
107+
![](./tui2.png)
108+
109+
### 命令别名
110+
111+
工具响应以下命令:`agentx``agents``ax`
112+
113+
## 配置
114+
115+
### 代理配置路径
116+
117+
| Agent | 配置路径 |
118+
|-------|----------|
119+
| Claude Code | `~/.claude.json` |
120+
| Codex | `~/.codex/config.toml` |
121+
| Cursor | `~/.cursor/mcp.json` |
122+
| Gemini CLI | `~/.gemini/settings.json` |
123+
| OpenCode | `~/.opencode/config.json` |
124+
125+
### 技能存储
126+
127+
Claude Code:
128+
129+
| Scope | Skills Directory | Commands Directory |
130+
|-------|------------------|-------------------|
131+
| Personal | `~/.claude/skills/` | `~/.claude/commands/` |
132+
| Project | `.claude/skills/` | `.claude/commands/` |
133+
134+
Codex:
135+
136+
| Scope | Skills Directory |
137+
|-------|------------------|
138+
| Personal | `$CODEX_HOME/skills/`(默认 `~/.codex/skills/`|
139+
| Project | `.codex/skills/` |
140+
141+
## 项目结构
142+
143+
```
144+
agentx/
145+
├── cmd/ # CLI 命令
146+
├── internal/
147+
│ ├── agent/ # 代理实现(Claude, Codex, Cursor, Gemini, OpenCode)
148+
│ ├── config/ # 配置管理
149+
│ ├── skills/ # 技能管理
150+
│ ├── mcp/ # MCP 相关逻辑
151+
│ └── version/ # 版本信息
152+
├── ui/
153+
│ ├── components/ # 可复用 UI 组件
154+
│ ├── views/ # 视图(MCP、Skills、Agents)
155+
│ └── theme/ # 主题样式
156+
├── main.go # 入口
157+
├── Makefile # 构建目标
158+
└── go.mod # Go 模块定义
159+
```
160+
161+
## 可用技能
162+
163+
AgentX 内置了以下预配置技能:
164+
165+
| Skill | Description |
166+
|-------|-------------|
167+
| `frontend-design` | 生产级 UI 设计 |
168+
| `mcp-builder` | 构建 MCP 服务器 |
169+
| `pdf` | PDF 文档处理 |
170+
| `docx` | Word 文档处理 |
171+
| `xlsx` | Excel 文档处理 |
172+
| `pptx` | PowerPoint 文档处理 |
173+
174+
## 许可证
175+
176+
Apache 2.0 - 详见 [LICENSE](LICENSE)

0 commit comments

Comments
 (0)