Skip to content

README-zh.md

Latest commit

 

History

History
196 lines (133 loc) · 3.51 KB

README-zh.md

File metadata and controls

196 lines (133 loc) · 3.51 KB

🎮 Cocos CLI

Node.js Cocos Engine License

cli logo

🚀 专为 Cocos Engine 开发设计的强大命令行界面工具

✨ 功能

  • 🏗️ 项目管理：创建、导入、构建 Cocos 项目
  • 📦 资源管理：导入导出资源，批量处理
  • ⚡ 构建系统：多平台构建支持
  • 🎨 交互式界面：向导式操作流程

📋 环境要求

  • Node.js 22.17.0
  • Git
  • Visual Studio with C++ build tools (Windows 系统)
  • Xcode (macOS 系统)

原生开发请参考 原生开发环境搭建指南 获取详细的搭建说明。

🛠️ 安装

  1. 克隆仓库

    git clone <repository-url>
cd cocos-cli

  2. 安装依赖

    npm install -g node-gyp
npm run init
npm install

  3. 构建并链接到全局

    npm run build
npm link

🚀 快速开始

查看 快速开始指南 了解详细使用步骤。

📚 基本命令

# 创建项目
cocos create --project ./my-project

# 构建项目
cocos build --project ./my-project --platform web-mobile

# 导入项目
cocos import --project ./my-project

# 显示项目信息
cocos info --project ./my-project

# 启动 MCP 服务器
cocos start-mcp-server --project ./my-project --port 9527

# 交互式向导
cocos wizard

# 显示帮助
cocos --help

详细命令说明请查看 Commands 文档。

🛠️ 开发

开发模式

# 构建项目
npm run build

# 链接到全局
npm link

# 测试命令
cocos --help

故障排除

  1. 命令找不到

    npm list -g --depth=0
npm unlink -g cocos-cli
npm link

  2. 编译错误

    npm run build:clear
npm run build

  3. 调试模式

    cocos --debug build --project ./my-project

🔧 开发工具

# 下载开发工具
npm run download-tools

# 更新仓库依赖
npm run update:repos

🧪 测试

单元测试

# 运行所有单元测试
npm test

# 监听模式运行测试
npm run test:watch

# 生成覆盖率报告
npm run test:coverage

# 静默运行测试
npm run test:quiet

E2E 测试

# 运行 E2E 测试
npm run test:e2e

# 调试模式运行 E2E 测试（保留测试项目）
npm run test:e2e:debug

# 检查 E2E 测试覆盖率
npm run check:e2e-coverage

# 生成 E2E 覆盖率 HTML 报告
npm run check:e2e-coverage:report

运行所有测试

# 运行所有测试（单元 + E2E）
npm run test:all

查看更多测试详情：

📖 文档

🤝 贡献代码

我们欢迎贡献！请查看我们的贡献指南开始参与。

该指南涵盖：

  • 开发工作流和项目构建
  • 运行和编写测试
  • 代码风格和格式化
  • 调试技巧
  • 提交 Pull Request

📄 许可证

MIT License - 查看 LICENSE 文件了解详情。