vcool-cli

一个用于快速创建 vcool 后台管理系统项目的脚手架工具。

项目源码

vcool 项目模板托管在 Gitee 上，欢迎查看源码和贡献：

🔗 项目地址：https://gitee.com/vcooller/vcool

如果您在使用过程中遇到任何问题或有功能建议，欢迎：

• 📝 提交 Issue：https://gitee.com/vcooller/vcool/issues
• 🌟 给项目点个 Star
• 🤝 提交 Pull Request 贡献代码

特性

• 🚀 基于 Vue 3 + Vite 的现代化后台管理系统模板
• 💎 Element Plus UI 组件库
• 📦 集成 Pinia 状态管理
• 🎨 集成 Tailwind CSS
• 🔥 支持自动导入 API 和组件
• 📝 交互式命令行界面
• 🎯 支持多种包管理器（npm/yarn/pnpm）
• ✨ 可选的 Git 初始化和依赖安装

环境要求

• Node.js >= 20.19.0
• Git（用于克隆项目模板）

安装

npm install -g vcool-cli
# 或
yarn global add vcool-cli
# 或
pnpm add -g vcool-cli

使用

创建新项目

vcool create my-admin

在当前目录初始化项目

vcool init

强制覆盖已存在的目录

vcool create my-admin --force

查看版本和帮助

vcool --version
vcool --help

交互式选项

在创建项目时，CLI 会询问以下选项：

1. 项目名称 - 你的项目包名（将用于 package.json）
2. 项目描述 - 项目的简短描述
3. 作者 - 项目作者信息
4. 包管理器 - 选择 npm、yarn 或 pnpm
5. 初始化 Git - 是否初始化 Git 仓库
6. 安装依赖 - 是否立即安装项目依赖

项目结构

my-admin/
├── src/
│   ├── api/          # API 接口
│   ├── components/   # 公共组件
│   ├── layouts/      # 布局组件
│   ├── router/       # 路由配置
│   ├── stores/       # Pinia 状态管理
│   ├── views/        # 页面组件
│   └── main.js       # 入口文件
├── public/           # 公共资源
├── vite.config.js    # Vite 配置
├── tailwind.config.js # Tailwind 配置
└── package.json      # 项目配置

启动项目

cd my-admin
npm install
npm run dev

技术栈

• Vue 3 - 渐进式 JavaScript 框架
• Vite - 下一代前端构建工具
• Element Plus - Vue 3 UI 组件库
• Vue Router - 官方路由管理器
• Pinia - Vue 3 状态管理
• Tailwind CSS - 实用优先的 CSS 框架
• Axios - HTTP 客户端

许可证

MIT