ZY Code 是一个命令行 AI 自动化工具，针对 Qwen3-Coder 模型进行了优化，提供了增强的解析器支持和工具支持。并提供了一个强大的高级软件研发助手工作流。
本项目由 深圳展映科技 提供功能增强、改进。
本版本在个性化、安全性和项目特定的 AI 行为方面进行了重大改进。
- 代码理解与编辑：可查询和编辑超出传统上下文窗口限制的大型代码库
- 工作流自动化：自动化处理如 PR 管理、复杂 rebase 等操作任务
- 增强分析器：专为 Qwen-Coder 模型定制的分析器
-
项目分析：通过
/init命令自动分析并记录项目结构 -
增强工作流：通过
/task命令初始化工作流，通过新需求 定义需求信息，自动生成计划、处理任务 -
自定义规则与命令：在项目根目录的
.qwen/中定义 AI 行为和快捷方式 -
智能上下文：自动生成的
ZYCODE.md文件为所有 AI 交互提供丰富上下文 - 增强安全与隐私：安全存储凭据、文件隔离、完全关闭遥测
如果您在中国大陆，ModelScope 提供 每天 2000 次免费 API 调用。
- 代码理解与编辑 - 超越传统上下文窗口限制，查询和编辑大型代码库
- 工作流自动化 - 自动化操作任务，如处理拉取请求和复杂的 rebase
- 增强的解析器 - 专为 Qwen-Coder 模型优化的适配解析器
cd 您的项目/
zycode
> /init
> 描述该系统架构的主要部分自动分析项目并生成 ZYCODE.md，包括：
- 编程语言与框架
- 项目结构与关键目录
- 依赖与构建系统
- 测试策略
- Git 信息
- API 端点
- 配置文件与文档等
> 重构此函数以提高可读性和性能确保您已安装 Node.js 20 或更高版本。
或下载 一键安装的 bat 文件 ，点击右键，使用管理员身份安装。
推荐再安装 python, git , cygwin64 获得更好的体验。
npm install -g @zytech/zycode
zycode --version或：npm install --force -g @zytech/zycode
linux环境下手动安装：
curl -qL https://www.npmjs.com/install.sh | sh
npm install -g @zytech/zycode然后从任何地方运行（需配置API KEY，建议你进入到你的项目目录，然后shift+鼠标右键，选择命令行）：
zycode设置您的 Qwen API 密钥 (在 ZY Code 项目中，您也可以在 .env 文件中设置您的 API 密钥)。.env 文件应放置在您当前项目的根目录中。
.env 示例：
OPENAI_API_KEY="您的_API_密钥"
OPENAI_BASE_URL="https://api-inference.modelscope.cn/v1"
OPENAI_MODEL="Qwen/Qwen3-Coder-480B-A35B-Instruct"
ZYCODE_AUTH_KEY="demo"
⚠️ 说明：
如果您在中国大陆，请访问 https://bailian.console.aliyun.com/ 或 https://modelscope.cn/docs/model-service/API-Inference/intro 申请您的 API 密钥
如果您不在中国大陆，请访问 https://modelstudio.console.alibabacloud.com/ 申请您的 API 密钥
如果您在中国大陆，ModelScope 每天提供 2000 次免费模型推理 API 调用 （编辑 运行 zycode.bat)：
export OPENAI_API_KEY="您的_API_密钥"
export OPENAI_BASE_URL="https://api-inference.modelscope.cn/v1"
export OPENAI_MODEL="Qwen/Qwen3-Coder-480B-A35B-Instruct"
export ZYCODE_AUTH_KEY="demo"或者您可以通过阿里云百炼平台使用 Qwen3-Coder。
export OPENAI_API_KEY="您的_API_密钥"
export OPENAI_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
export OPENAI_MODEL="qwen3-coder-plus"
export ZYCODE_AUTH_KEY="demo"If you are not in mainland China, you can use Qwen3-Coder through the Alibaba Cloud modelstuido platform.
如果您不在中国大陆，您可以通过阿里云 modelstuido 平台使用 Qwen3-Coder。
export OPENAI_API_KEY="您的_API_密钥"
export OPENAI_BASE_URL="https://dashscope-intl.aliyuncs.com/compatible-mode/v1"
export OPENAI_MODEL="qwen3-coder-plus"
export ZYCODE_AUTH_KEY="demo"设置 ZYCODE_AUTH_KEY 环境变量。此密钥用于访问 ZYCODE 认证服务，能自动配置部分接口信息。
默认情况下，ZYCODE_AUTH_KEY 的值为 demo，如需大规模本地部署，请联系我们。
每次启动时，会认证一次，如果认证失败，系统将提示您联系我们获取有效的认证密钥，并在 20 分钟后自动退出，demo 2年内可用。
在项目根目录创建 .qwen/rules 和 .qwen/commands 目录，即可定义 AI 行为与快捷命令。
# 代码风格规范
本项目遵循严格的代码风格规范以确保可维护性和一致性。
## 通用原则
1. 使用一致的缩进（JS/TS 用 2 空格，Python 用 4 空格）
2. 变量与函数使用 camelCase 命名
3. 类与组件使用 PascalCase 命名
4. 始终使用 const 或 let，避免 var
5. 使用描述性变量名，表达意图
6. 函数保持短小，职责单一
7. 为所有导出函数和类添加 JSDoc 注释# 代码审查
对指定代码进行全面审查，聚焦最佳实践、潜在错误与优化建议。
## 用法
/review [文件路径或匹配模式]
## 模板
请对以下代码进行全面审查，重点关注：
1. **代码质量**：可读性、可维护性、最佳实践
2. **潜在错误**：逻辑错误、边界情况、运行时问题
3. **性能问题**：低效算法、内存泄漏、优化空间
4. **安全性**：潜在漏洞、安全最佳实践
5. **测试性**：测试可行性与覆盖率考虑
{{input}}
请提供具体、可操作的反馈，并附上示例代码。- 分析最近 7 天的 Git 提交，按功能与开发者分组
- 将目录中所有图片转换为 PNG 格式
| 任务类型 | 示例命令 |
|---|---|
| 理解新代码库 |
/init、描述业务逻辑主模块、数据流如何运作
|
| 重构与优化 |
/optimize src/utils/helpers.js、优化此模块、重构此类以遵循设计模式
|
| 文档与测试 |
/document getUserProfile、/review src/components/、为此函数添加 JSDoc
|
| 项目特定流程 |
/debug "TypeError: Cannot read property 'map' of undefined"、/analyze src/
|
| AI 自动提交 |
/auto-commit（完整流程）、--dry-run（仅预览） |
-
完整流程（含
package.json）：- AI 分析已暂存的更改
- 自动递增语义化版本号
- 更新
CHANGELOG.md - AI 生成提交信息并提交
-
简化流程（无
package.json）：- AI 分析更改
- 生成智能提交信息
- 自动提交
ZY Code 内建多重安全机制：
- 安全凭据存储：API 密钥存储于内存中，非环境变量
- 文件隔离：仅访问项目目录，防止系统敏感文件泄露
- 零遥测：默认关闭所有数据收集与遥测功能
- 环境净化：隔离环境中清除敏感变量，防止泄露
cd 您的项目/
zycode
> 描述该系统架构的主要部分> 重构此函数以提高可读性和性能> 分析过去 7 天的 git 提交，按功能和团队成员分组> 将此目录中的所有图像转换为 PNG 格式> 核心业务逻辑组件是什么？
> 有哪些安全机制？
> 数据流是如何工作的？
> 该模块的哪些部分可以优化？
> 帮我重构这个类以遵循更好的设计模式
> 添加适当的错误处理和日志记录
> 为此函数生成全面的 JSDoc 注释
> 为此组件编写单元测试
> 创建 API 文档
如果您遇到问题，请查看故障排除指南。