@zpeak/cli

@zpeak/cli 是一个多功能的命令行工具集，旨在通过提供一系列命令来简化开发工作流程。目前支持项目模板生成功能，并计划扩展更多实用功能。

功能特性

• 🚀 项目模板生成（当前版本）
• 🔧 未来将支持更多开发工具功能
• 🎯 交互式命令行界面
• 🌐 自动从远程仓库同步最新资源
• 🛠️ 简单易用的命令和选项

安装

使用 npm 全局安装：

npm install -g @zpeak/cli

或者使用 yarn：

yarn global add @zpeak/cli

或者使用 pnpm：

pnpm add -g @zpeak/cli

使用

安装完成后，可以通过 peak 或 zpeak 命令来使用该工具：

# peak / zpeak
zpeak <command> [options]

当前可用命令

template

根据指定模板生成项目。

• 别名: t
• 用法: peak template [originName] [projectName]

参数

• originName (可选): 要使用的模板的名称。如果未提供，将显示可用模板列表供您选择。
• projectName (可选): 新项目的名称。如果未提供，系统将提示您输入项目名称。

选项

• -p, --path <path>: 指定生成项目模板的路径。默认为当前目录。

示例

# 使用交互式方式选择模板并创建项目
peak template

# 使用指定模板创建项目
peak template pnpm-monorepo my-project

# 指定项目生成路径
peak template pnpm-monorepo my-project -p ./projects

模板仓库

CLI 工具会自动从以下远程仓库获取模板：

https://gitee.com/Iontheroad/project-template.git

本地缓存路径：

{系统临时目录}/zpeak-template

未来规划

@zpeak/cli 正在积极开发中，未来版本将添加更多实用命令，敬请期待！

故障排除

如果遇到问题，请尝试以下解决方案：

1. 清除本地缓存并重新下载模板：

   # 删除本地缓存目录后重新运行命令

2. 检查网络连接是否正常，确保可以访问模板仓库。

3. 更新到最新版本：

   npm update -g @zpeak/cli

贡献

欢迎提交 Issue 和 Pull Request 来帮助我们改进这个工具。

许可证

MIT