bowl-cli
v1.0.1
Published
A simple and easy-to-use front-end project scaffolding tool
Maintainers
Readme
bowl-cli
✨ 特性
- 🚀 快速创建前端项目
- 📦 支持多种项目模板
- 🎨 美观的命令行交互界面
- 🔄 支持版本选择
- ⚡️ 简单易用的命令
📦 安装
全局安装
npm install -g bowl-cli本地开发
git clone https://github.com/Charles-xionger/bowl-cli.git
cd bowl-cli
npm install
npm link🚀 快速开始
创建新项目
bo create my-project执行命令后,CLI 会引导你完成以下步骤:
- 检查目标目录是否存在
- 选择项目模板
- 选择模板版本
- 自动下载并创建项目
强制覆盖已存在的目录
bo create my-project -f
# 或
bo create my-project --force📖 命令说明
bo create <projectName>
创建一个新项目
参数:
<projectName>: 项目名称(必填)
选项:
-f, --force: 强制覆盖已存在的目录
示例:
# 创建一个名为 my-app 的项目
bo create my-app
# 强制创建,覆盖已存在的 my-app 目录
bo create my-app -fbo config [value]
查看和修改配置(开发中)
选项:
-g, --get <path>: 获取配置值-s, --set <path> <value>: 设置配置值-d, --delete <path>: 删除配置项
bo ui
启动可视化界面(开发中)
选项:
-p, --port <port>: 指定 UI 服务器端口
bo --version
查看当前版本
bo --version
# 或
bo -Vbo --help
查看帮助信息
bo --help
# 或
bo -h🛠️ 技术栈
- Commander.js - 命令行参数解析
- Inquirer.js - 交互式命令行界面
- Chalk - 终端字符串样式
- Ora - 优雅的终端加载动画
- download-git-repo - 下载 Git 仓库
- Figlet - ASCII 艺术字生成
- Axios - HTTP 客户端
- fs-extra - 文件系统增强
📂 项目结构
bowl-cli/
├── bin/
│ └── cli.js # CLI 入口文件,定义所有命令
├── lib/
│ ├── create.js # 项目创建逻辑,处理目录检查和用户交互
│ ├── Generator.js # 模板生成器核心类,负责模板下载
│ └── http.js # GitHub API 请求封装
├── package.json # 项目配置文件
└── README.md # 项目说明文档🔧 工作原理
- 模板获取: 从 GitHub 组织
boboCLI获取所有可用的模板仓库 - 版本选择: 获取所选模板的所有标签版本供用户选择
- 模板下载: 使用
download-git-repo下载指定版本的模板 - 项目创建: 将模板复制到目标目录并完成项目初始化
🤝 贡献
欢迎提交 Issue 和 Pull Request!
开发步骤
- Fork 本仓库
- 创建你的特性分支 (
git checkout -b feature/AmazingFeature) - 提交你的改动 (
git commit -m 'Add some AmazingFeature') - 推送到分支 (
git push origin feature/AmazingFeature) - 开启一个 Pull Request
📝 开发计划
- [ ] 完善配置管理功能
- [ ] 实现可视化 UI 界面
- [ ] 支持自定义模板源
- [ ] 添加插件系统
- [ ] 支持更多框架模板(React、Angular 等)
- [ ] 添加单元测试
- [ ] 支持模板本地缓存
📄 License
👨💻 作者
bobo
- Email: [email protected]
🙏 致谢
感谢所有为这个项目做出贡献的开发者!
