@unity-china/codely-cli 1.0.0-beta.33 → 1.0.0-beta.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  <div align="center">
4
4
 
5
- ![Codely CLI Screenshot](./docs/assets/codely-screenshot.png)
5
+ ![Codely CLI Screenshot](https://internal-api-drive-stream.feishu.cn/space/api/box/stream/download/v2/cover/SDRJbcEfUoQRsVxcPJ8ccKTdnMc/?fallback_source=1&height=1280&mount_node_token=JRnkdygOJoQcpyxlCQncsGtMnTc&mount_point=docx_image&policy=equal&width=1280)
6
6
 
7
7
  [![npm version](https://img.shields.io/npm/v/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
8
8
  [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](./LICENSE)
@@ -11,7 +11,9 @@
11
11
 
12
12
  **AI-powered command-line workflow tool for developers**
13
13
 
14
- [Installation](#installation) [Quick Start](#quick-start) • [Features](#key-features) • [Documentation](./docs/)
14
+ 🌐 [Official Website](https://codely.tuanjie.cn/) • 📖 [Documentation](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb) • 🇨🇳 [中文文档](./README.zh-CN.md)
15
+
16
+ [Installation](#installation) • [Quick Start](#quick-start) • [Features](#key-features)
15
17
 
16
18
  </div>
17
19
 
@@ -21,6 +23,10 @@
21
23
  - **Workflow Automation** - Automate operational tasks like handling pull requests and complex rebases
22
24
  - **AI Agent System** - Specialized intelligent agents for deep codebase analysis and automated tasks
23
25
  - **MCP Integration** - Extend capabilities with Model Context Protocol servers for external tools and services
26
+ - **Unity Integration** - Direct integration with Unity/Tuanjie Engine for game development tasks
27
+ - **Screenshot Analysis** - Analyze screenshots and images to understand UI/UX and extract information
28
+ - **Sandboxing** - Secure execution environment with multiple sandboxing modes
29
+ - **IDE Plugin** - VS Code extension for seamless integration
24
30
 
25
31
  ## 🤖 AI Agent System
26
32
 
@@ -314,7 +320,10 @@ Remove an MCP server with the specified name.
314
320
 
315
321
  ## Troubleshooting
316
322
 
317
- If you encounter issues, check the [troubleshooting guide](docs/troubleshooting.md).
323
+ If you encounter issues, please check the error messages and ensure:
324
+ - Node.js version is 20 or higher
325
+ - All dependencies are properly installed
326
+ - API keys are correctly configured in settings
318
327
 
319
328
  ## License
320
329
 
@@ -0,0 +1,335 @@
1
+ # Codely CLI
2
+
3
+ <div align="center">
4
+
5
+ ![Codely CLI 截图](https://internal-api-drive-stream.feishu.cn/space/api/box/stream/download/v2/cover/SDRJbcEfUoQRsVxcPJ8ccKTdnMc/?fallback_source=1&height=1280&mount_node_token=JRnkdygOJoQcpyxlCQncsGtMnTc&mount_point=docx_image&policy=equal&width=1280)
6
+
7
+ [![npm 版本](https://img.shields.io/npm/v/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
8
+ [![许可证](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](./LICENSE)
9
+ [![Node.js 版本](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
10
+ [![下载量](https://img.shields.io/npm/dm/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
11
+
12
+ **面向开发者的 AI 驱动命令行工作流工具**
13
+
14
+ 🌐 [官方网站](https://codely.tuanjie.cn/) • 📖 [使用手册](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb) • 🇺🇸 [English](./README.md)
15
+
16
+ [安装](#安装) • [快速开始](#快速开始) • [核心功能](#核心功能)
17
+
18
+ </div>
19
+
20
+ ## 核心功能
21
+
22
+ - **代码理解与编辑** - 查询和编辑超出传统上下文窗口限制的大型代码库
23
+ - **工作流自动化** - 自动化处理拉取请求和复杂变基等操作任务
24
+ - **AI 智能体系统** - 专业的智能代理,用于深度代码库分析和自动化任务
25
+ - **MCP 集成** - 通过模型上下文协议服务器扩展外部工具和服务能力
26
+ - **Unity 集成** - 与 Unity/团结引擎直接集成,支持游戏开发任务
27
+ - **截图分析** - 分析截图和图像以理解 UI/UX 并提取信息
28
+ - **沙箱环境** - 多种沙箱模式的安全执行环境
29
+ - **IDE 插件** - VS Code 扩展实现无缝集成
30
+
31
+ ## 🤖 AI 智能体系统
32
+
33
+ Codely CLI 包含强大的智能体系统,提供专业的 AI 助手处理复杂的开发任务:
34
+
35
+ ### 智能体使用
36
+
37
+ **交互模式**(智能体自动调用):
38
+
39
+ ```bash
40
+ codely
41
+ > 分析这个 React 项目的组件架构并识别性能瓶颈
42
+ ```
43
+
44
+ **非交互模式**支持不同的输出格式:
45
+
46
+ ```bash
47
+ # 标准文本输出
48
+ codely --prompt "分析 API 端点和安全措施"
49
+
50
+ # JSON 输出用于自动化
51
+ codely --output-format json --prompt "调查代码库结构" > analysis.json
52
+
53
+ # 流式 JSON 用于实时监控
54
+ codely --output-format stream-json --prompt "记录数据流" | jq '.type == "agent_think"'
55
+ ```
56
+
57
+ ### 智能体管理
58
+
59
+ **列出可用的智能体:**
60
+
61
+ ```bash
62
+ /agents list
63
+ ```
64
+
65
+ **创建自定义智能体:**
66
+
67
+ ```bash
68
+ # 项目级别智能体
69
+ /agents create security-auditor
70
+
71
+ # 全局智能体
72
+ /agents create my-helper --global
73
+
74
+ # 带自定义描述
75
+ /agents create api-analyzer "分析 API 端点和文档"
76
+ ```
77
+
78
+ **智能体位置:**
79
+
80
+ - **项目智能体**:`.codely-cli/agents/`(与团队共享)
81
+ - **全局智能体**:`~/.codely-cli/agents/`(个人使用)
82
+
83
+ ### 智能体输出示例
84
+
85
+ 智能体提供结构化的完整结果:
86
+
87
+ **交互式进度:**
88
+
89
+ ```
90
+ 🚀 委派给 codebase_investigator 子智能体...
91
+ 🔧 [1] 列出目录 - 扫描项目结构
92
+ ✅ 列出目录完成 - 找到 45 个目录
93
+ 🤖💭 正在分析 package.json 依赖...
94
+ 🔧 [2] 读取文件 - package.json
95
+ ✅ 读取文件完成 - 分析依赖中
96
+ 📋 结果:
97
+ {
98
+ "SummaryOfFindings": "React 应用采用三层架构...",
99
+ "ExplorationTrace": ["分析项目结构", "检查路由"],
100
+ "RelevantLocations": ["src/components/App.tsx", "src/api/routes.ts"]
101
+ }
102
+ ```
103
+
104
+ ## 安装
105
+
106
+ ### 前置要求
107
+
108
+ 确保已安装 [Node.js 20](https://nodejs.org/en/download) 或更高版本。
109
+
110
+ ### 直接安装
111
+
112
+ ```bash
113
+ npm i -g @unity-china/codely-cli
114
+ ```
115
+
116
+ ## 快速开始
117
+
118
+ ```bash
119
+ # 启动
120
+ codely
121
+
122
+ # 示例命令
123
+ > 解释这个代码库结构
124
+ > 帮我重构这个函数
125
+ > 为这个模块生成单元测试
126
+ ```
127
+
128
+ ### 会话管理
129
+
130
+ 通过可配置的会话限制控制您的 token 使用量,以优化成本和性能。
131
+
132
+ #### 配置会话 Token 限制
133
+
134
+ 在您的主目录中创建或编辑 `.codely-cli/settings.json`:
135
+
136
+ ```json
137
+ {
138
+ "sessionTokenLimit": 32000
139
+ }
140
+ ```
141
+
142
+ #### 会话命令
143
+
144
+ - **`/compress`** - 压缩对话历史以继续在 token 限制内使用
145
+ - **`/clear`** - 清除所有对话历史并重新开始
146
+ - **`/stats`** - 检查当前 token 使用情况和限制
147
+
148
+ > 📝 **注意**:会话 token 限制适用于单次对话,而非累计 API 调用。
149
+
150
+ ## 使用示例
151
+
152
+ ### 🔍 探索代码库
153
+
154
+ ```bash
155
+ cd your-project/
156
+ codely
157
+
158
+ # 架构分析
159
+ > 描述这个系统架构的主要部分
160
+ > 关键依赖是什么,它们如何交互?
161
+ > 查找所有 API 端点及其认证方法
162
+ ```
163
+
164
+ ### 💻 代码开发
165
+
166
+ ```bash
167
+ # 重构
168
+ > 重构这个函数以提高可读性和性能
169
+ > 将这个类转换为使用依赖注入
170
+ > 将这个大模块拆分成更小、更专注的组件
171
+
172
+ # 代码生成
173
+ > 创建一个用户管理的 REST API 端点
174
+ > 为认证模块生成单元测试
175
+ > 为所有数据库操作添加错误处理
176
+ ```
177
+
178
+ ### 🔄 自动化工作流
179
+
180
+ ```bash
181
+ # Git 自动化
182
+ > 分析过去 7 天的 git 提交,按功能分组
183
+ > 从最近的提交创建变更日志
184
+ > 查找所有 TODO 注释并创建 GitHub issues
185
+
186
+ # 文件操作
187
+ > 将此目录中的所有图像转换为 PNG 格式
188
+ > 将所有测试文件重命名为 *.test.ts 模式
189
+ > 查找并删除所有 console.log 语句
190
+ ```
191
+
192
+ ### 🐛 调试与分析
193
+
194
+ ```bash
195
+ # 性能分析
196
+ > 识别这个 React 组件中的性能瓶颈
197
+ > 在代码库中查找所有 N+1 查询问题
198
+
199
+ # 安全审计
200
+ > 检查潜在的 SQL 注入漏洞
201
+ > 查找所有硬编码的凭据或 API 密钥
202
+ ```
203
+
204
+ ## 常用任务
205
+
206
+ ### 📚 理解新代码库
207
+
208
+ ```text
209
+ > 核心业务逻辑组件是什么?
210
+ > 有哪些安全机制?
211
+ > 数据如何在系统中流动?
212
+ > 使用了哪些主要设计模式?
213
+ > 为这个模块生成依赖关系图
214
+ ```
215
+
216
+ ### 🔨 代码重构与优化
217
+
218
+ ```text
219
+ > 这个模块的哪些部分可以优化?
220
+ > 帮我重构这个类以遵循 SOLID 原则
221
+ > 添加适当的错误处理和日志记录
222
+ > 将回调转换为 async/await 模式
223
+ > 为昂贵的操作实现缓存
224
+ ```
225
+
226
+ ### 📝 文档与测试
227
+
228
+ ```text
229
+ > 为所有公共 API 生成全面的 JSDoc 注释
230
+ > 编写包含边界情况的单元测试
231
+ > 以 OpenAPI 格式创建 API 文档
232
+ > 添加解释复杂算法的内联注释
233
+ > 为这个模块生成 README
234
+ ```
235
+
236
+ ### 🚀 开发加速
237
+
238
+ ```text
239
+ > 设置一个带认证的新 Express 服务器
240
+ > 创建一个带 TypeScript 和测试的 React 组件
241
+ > 实现一个速率限制中间件
242
+ > 为新架构添加数据库迁移
243
+ > 为这个项目配置 CI/CD 流水线
244
+ ```
245
+
246
+ ## 命令与快捷键
247
+
248
+ ### 会话命令
249
+
250
+ - `/help` - 显示可用命令
251
+ - `/clear` - 清除对话历史
252
+ - `/compress` - 压缩历史以节省 tokens
253
+ - `/stats` - 显示当前会话信息
254
+ - `/exit` 或 `/quit` - 退出 Codely CLI
255
+
256
+ ### MCP 命令
257
+
258
+ 管理模型上下文协议(MCP)服务器以扩展 Codely 的外部工具和服务能力:
259
+
260
+ - `/mcp` - 列出已配置的 MCP 服务器及其可用工具
261
+ - `/mcp desc` - 显示服务器和工具的详细描述
262
+ - `/mcp schema` - 显示工具参数架构
263
+ - `/mcp auth <server-name>` - 对启用 OAuth 的 MCP 服务器进行身份验证
264
+ - `/mcp refresh` - 刷新 MCP 服务器和工具列表
265
+
266
+ 管理 MCP 服务器配置的 CLI 命令:
267
+
268
+ #### `codely mcp add <name> <commandOrUrl> [args...]`
269
+
270
+ 添加具有指定名称和连接详情的新 MCP 服务器。
271
+
272
+ **选项:**
273
+
274
+ - `--scope` (`-s`) - 配置范围(user 或 project)
275
+ - `--transport` (`-t`) - 传输类型(stdio、sse、http)
276
+ - `--env` (`-e`) - 为 stdio 传输设置环境变量(例如 `-e KEY=value`)
277
+ - `--header` (`-H`) - 为 SSE 和 HTTP 传输设置 HTTP 头(例如 `-H "X-Api-Key: abc123"`)
278
+ - `--timeout` - 连接超时时间(毫秒)
279
+ - `--trust` - 信任服务器(绕过所有工具调用确认提示)
280
+ - `--description` - 服务器描述
281
+ - `--include-tools` - 要包含的工具的逗号分隔列表
282
+ - `--exclude-tools` - 要排除的工具的逗号分隔列表
283
+
284
+ **传输类型:**
285
+
286
+ - `stdio`(默认)- 使用指定的命令和参数启动进程
287
+ - `sse` - 使用服务器发送事件协议连接到服务器
288
+ - `http` - 使用 HTTP 协议连接到服务器
289
+
290
+ **示例:**
291
+
292
+ ```bash
293
+ # 添加 stdio 服务器
294
+ codely mcp add my-server python /path/to/server.py --env API_KEY=abc123
295
+
296
+ # 添加 HTTP 服务器
297
+ codely mcp add my-http-server http://localhost:8000 --transport http --header "Authorization: Bearer token"
298
+
299
+ # 添加具有范围配置的服务器
300
+ codely mcp add my-server python /path/to/server.py --scope user
301
+ ```
302
+
303
+ #### `codely mcp list`
304
+
305
+ 列出所有已配置的 MCP 服务器及其连接状态。
306
+
307
+ #### `codely mcp remove <name>`
308
+
309
+ 删除具有指定名称的 MCP 服务器。
310
+
311
+ **选项:**
312
+
313
+ - `--scope` (`-s`) - 配置范围(user 或 project)
314
+
315
+ ### 键盘快捷键
316
+
317
+ - `Ctrl+C` - 取消当前操作
318
+ - `Ctrl+D` - 退出(在空行上)
319
+ - `上/下箭头` - 浏览命令历史
320
+
321
+ ## 故障排除
322
+
323
+ 如果您遇到问题,请检查错误消息并确保:
324
+ - Node.js 版本为 20 或更高
325
+ - 所有依赖项已正确安装
326
+ - API 密钥在设置中正确配置
327
+
328
+ 如需更多帮助,请访问:
329
+ - 🌐 [官方网站](https://codely.tuanjie.cn/)
330
+ - 📖 [使用手册](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb)
331
+
332
+ ## 许可证
333
+
334
+ [LICENSE](./LICENSE)
335
+
package/bundle/gemini.js CHANGED
@@ -417144,7 +417144,7 @@ async function getPackageJson2() {
417144
417144
  // packages/cli/src/utils/version.ts
417145
417145
  async function getCliVersion() {
417146
417146
  const pkgJson = await getPackageJson2();
417147
- return "1.0.0-beta.33";
417147
+ return "1.0.0-beta.34";
417148
417148
  }
417149
417149
 
417150
417150
  // packages/cli/src/ui/commands/types.ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unity-china/codely-cli",
3
- "version": "1.0.0-beta.33",
3
+ "version": "1.0.0-beta.34",
4
4
  "engines": {
5
5
  "node": ">=20.0.0"
6
6
  },
@@ -60,6 +60,7 @@
60
60
  "files": [
61
61
  "bundle/",
62
62
  "README.md",
63
+ "README.zh-CN.md",
63
64
  "LICENSE"
64
65
  ],
65
66
  "publishConfig": {