Appearance
Magus Agent 开发手册
安装方式
Magus 提供 Skill 版本 和 Agent 版本 两种安装方式,请根据实际需求选择。
Skill 版本
💡 推荐用于 Claude Code、Codex 等较强的 Agent 工具。
- 不限制模型推理逻辑
- 不影响代码生成效果
- 适合大多数开发场景
macOS
bash
curl -fsSL https://doc.magustek.com/skill/install/install.sh | bashWindows
powershell
irm https://doc.magustek.com/skill/install/install.ps1 | iex离线安装包
Agent 版本
💡 推荐用于能力较弱的模型或工具。
Agent 版本内置更多纠错规则,可有效减少代码生成偏差,提高输出稳定性。
macOS
bash
curl -fsSL https://doc.magustek.com/agent/install/install.sh | bashWindows
powershell
irm https://doc.magustek.com/agent/install/install.ps1 | iex离线安装包
本地开发环境
以下版本为 Magus 项目推荐的本地开发基线。
⚠️ 如果项目已通过
pom.xml、package.json、.nvmrc、packageManager、Maven Wrapper 等文件锁定版本,请优先使用项目指定版本。
| 环境 | 推荐版本 | 是否必需 | 用途 |
|---|---|---|---|
| JDK | 17 | 后端必需 | 编译与运行 Java / Spring Boot 项目 |
| Maven | 稳定版本 | 后端必需 | 依赖管理、编译、测试与打包 |
| Node.js | ≥ 22(推荐 24.12.0) | 前端必需 | Vue、TypeScript、Vite 等前端工具链 |
| pnpm | 10.x(推荐 10.28.1) | 前端必需 | 前端依赖安装与构建 |
| Chrome / Chromium | 当前稳定版 | 按需 | 页面调试与视觉验收 |
环境说明
后端开发
需安装:
- JDK 17
- Maven
项目包含
mvnw时,优先使用 Maven Wrapper。
前端开发
需安装:
- Node.js
- pnpm
Magus 新版前端项目默认使用 pnpm。
浏览器调试
建议安装:
- Chrome
- Chromium
用于:
- 页面预览
- 调试
- 自动化测试
- UI 验收
包管理器选择
请根据项目中的 Lock 文件选择对应工具:
| 文件 | 使用工具 |
|---|---|
| pnpm-lock.yaml | pnpm |
| package-lock.json | npm |
| yarn.lock | Yarn |
Maven 配置要求
开始后端开发前,请确保:
- 已配置 Maven 本地仓库
- 已配置
settings.xml - 能正常访问公司 Maven 私服(如有)
使用步骤
第一步:准备项目
选择以下任意一种方式:
- 打开已有项目目录
- 新建项目目录
第二步:安装 Magus Agent
根据需要选择:
- Skill 版本
- Agent 版本
执行对应安装命令完成安装。
第三步:配置 Agent 工具
打开你使用的 Agent 工具,例如:
- Claude Code
- Codex
- OpenCode
- Trae
将当前项目目录添加到工作区。
第四步:开始开发
直接输入你的需求,例如:
text
# **需求文档
# 1. 项目背景
---
# 2. 系统边界
---
# 3. 功能需求
---
# 4. **功能
## 4.1 功能说明
---
## 4.2 功能范围
---
## 4.3 字段
---
# 5. **功能
# 6. **功能
# 7. **功能
# 8. **功能
# 9. 数据关系要求
---
# 10. 业务规则
---Agent 将自动分析项目结构并开始生成代码。
常见问题
Node.js 必须安装吗?
不一定:
- 仅开发后端:无需安装 Node.js
- 仅开发前端:无需安装 JDK 和 Maven
- 全栈开发:建议全部安装
Maven Wrapper 与本地 Maven 如何选择?
若项目包含:
text
mvnw
mvnw.cmd则优先使用:
bash
./mvnw以确保团队开发环境一致。
帮助中心