LEQ CLI 脚手架工具

🚀 一个强大的命令行工具，用于快速创建各种类型的项目模板

✨ 特性

• 🎯 多模板支持 - 支持微信小程序、抖音小程序、H5 网页、管理后台等多种项目模板
• 🚀 快速创建 - 一条命令快速拉取 GitLab 仓库模板代码
• 🎨 交互式体验 - 友好的命令行交互界面
• ⚙️ 智能配置 - 自动配置项目信息和 package.json
• 🔧 Git 集成 - 自动初始化 Git 仓库
• 💻 跨平台 - 支持 Windows、macOS、Linux

📦 安装

全局安装（推荐）

# 从 npm 安装
npm install -g leq-cli

从源码安装

如果需要使用最新开发版本：

git clone <repository-url>
cd leq-cli
npm install
npm link

验证安装

# 检查版本
lq-cli --version

# 查看帮助
lq-cli --help

🚀 快速开始

基本用法

# 交互式创建项目
lq-cli create my-project

# 指定模板类型创建项目
lq-cli create my-app -t 微信小程序

# 强制覆盖已存在的项目
lq-cli create my-app --force

# 查看所有可用模板
lq-cli list

# 查看帮助信息
lq-cli --help

临时使用（无需安装）

如果不想全局安装，可以使用以下方式：

# 使用 npx 临时运行
npx leq-cli create my-project

# 或者克隆后直接运行
git clone <repository-url>
cd leq-cli
npm install
node cli.js create my-project

📋 可用模板

| 模板类型 | 描述 | 技术栈 | 适用场景 | | --------------------- | ---------------------------------------------------- | --------------- | ------------------ | | 🔥 微信小程序 | 微信生态小程序开发模板，包含完整的项目结构和常用组件 | 微信小程序原生 | 微信生态应用开发 | | 🛒 淘宝小程序 | 淘宝/支付宝小程序开发模板，支持电商业务场景 | 支付宝小程序 | 电商、支付业务 | | 🖥️ 管理后台 | 后台管理系统模板，包含用户管理、权限控制等功能 | Vue/Element | 后台管理系统 | | 🌐 服务端渲染官网 | 服务端渲染官网模板，SEO 友好，性能优化 | Next.js/Nuxt.js | 企业官网、SEO 需求 | | 🛠️ 自定义模板 | 支持从自定义 Git 仓库地址拉取模板 | 自定义 | 个性化模板需求 |

🎯 命令详解

📝 全局命令选项

lq-cli --version  # 或 -v, -V  查看版本信息
lq-cli --help     # 查看帮助信息

🎨 create 命令

创建新项目，支持交互式选择或命令行参数指定模板。

lq-cli create [项目名] [选项]
# 别名：lq-cli c [项目名] [选项]

参数说明：

• 项目名 - 可选参数，目标项目的文件夹名称
  • 如果不提供，工具会询问用户输入
  • 支持相对路径和绝对路径
  • 示例：my-project、./projects/my-app

可用选项：

• -t, --template <类型> - 指定模板类型，跳过交互式选择菜单
  • 支持的类型：微信小程序、淘宝小程序、管理后台、服务端渲染官网、自定义模板
• -f, --force - 强制覆盖已存在的同名项目文件夹
  • 注意：此操作会完全删除现有文件夹，请谨慎使用

使用示例：

# 1. 交互式创建（推荐新手使用）
lq-cli create
lq-cli c  # 使用别名

# 2. 指定项目名，交互式选择模板
lq-cli create my-awesome-project
lq-cli c my-awesome-project

# 3. 完全指定参数，跳过所有交互
lq-cli create my-app -t 微信小程序
lq-cli c my-app -t H5网页端

# 4. 强制覆盖现有项目
lq-cli create existing-project --force
lq-cli c existing-project -f

# 5. 创建到指定目录
lq-cli create ./projects/new-app -t 管理后台

📋 list 命令

查看所有可用的项目模板及其详细描述。

lq-cli list
# 别名：lq-cli ls

功能说明：

• 显示所有可用模板的名称和描述
• 提供使用示例
• 帮助用户了解各模板的特点和适用场景

输出内容：

• ✅ 模板名称（用于 -t 参数）
• 📝 模板描述和特点
• 💡 使用示例

🆘 help 命令

查看详细的帮助信息和使用示例。

lq-cli --help
lq-cli -h        # 全局帮助
lq-cli create --help  # 特定命令帮助

🔧 项目配置

创建项目后，工具会询问以下配置信息：

• 项目名称 - 项目的名称（默认使用文件夹名）
• 项目描述 - 项目的简短描述
• 关键词 - 项目关键词（用逗号分隔）
• 作者 - 项目作者信息

这些信息会自动更新到项目的 package.json 文件中。

📝 使用流程

1. 运行创建命令

   lq-cli create my-project

2. 选择模板类型

   • 如果没有通过 -t 参数指定，会显示交互式选择菜单

3. 下载模板代码

   • 从 GitLab 拉取对应分支的模板代码

4. 配置项目信息

   • 填写项目名称、描述、关键词等信息

5. 初始化 Git 仓库

   • 自动初始化 Git 仓库

6. 开始开发

   cd my-project
   npm install
   npm run dev

⚙️ 环境要求

• Node.js >= 14.0.0
• npm >= 6.0.0
• Git >= 2.0.0（可选，用于 Git 初始化）

💡 使用示例和最佳实践

🌟 典型使用场景

场景一：团队协作开发微信小程序

# 1. 创建项目
lq-cli create wechat-mall -t 微信小程序

# 2. 配置项目信息
# 项目名称: 微信商城小程序
# 项目描述: 一个完整的微信小程序电商解决方案
# 关键词: 微信小程序,电商,商城
# 作者: 团队名称

# 3. 进入项目目录
cd wechat-mall

# 4. 安装依赖并启动开发
npm install
npm run dev

场景二：快速搭建管理后台

# 使用交互式创建，体验完整流程
lq-cli create admin-dashboard

# 选择管理后台模板
# 配置项目信息后自动初始化 Git 仓库
# 可立即开始开发

场景三：批量创建多个项目

# 创建主项目（微信小程序）
lq-cli c mall-mini -t 微信小程序

# 创建管理后台
lq-cli c mall-admin -t 管理后台

📋 项目结构说明

创建项目后，通常会得到以下目录结构：

my-project/
├── src/                 # 源代码目录
├── pages/              # 页面文件（小程序）
├── components/         # 组件目录
├── utils/              # 工具函数
├── styles/             # 样式文件
├── assets/             # 静态资源
├── package.json        # 项目配置文件
├── README.md           # 项目说明文档
└── .gitignore         # Git 忽略规则

❓ 常见问题解答

Q: 安装或运行时遇到权限问题怎么办？

A:

# 方法一：使用 sudo（Linux/macOS）
sudo npm install -g leq-cli

# 方法二：修改 npm 默认目录（推荐）
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

# 方法三：使用 npx（临时使用）
npx leq-cli create my-project

Q: 下载模板时网络超时怎么办？

A:

# 设置 npm 镜像源
npm config set registry https://registry.npmmirror.com

# 或者使用代理
npm config set proxy http://your-proxy:port
npm config set https-proxy http://your-proxy:port

# 重试创建项目
lq-cli create my-project -t 微信小程序

Q: 创建项目后如何自定义配置？

A:

1. 修改 package.json：更新项目信息、依赖版本等
2. 配置开发环境：根据模板类型配置相应的开发工具
3. 调整项目结构：根据团队规范调整文件夹结构
4. 更新 README：编写项目特定的说明文档

Q: 如何添加自定义模板？

A:

1. 准备 Git 仓库，包含完整的项目模板
2. 使用自定义模板选项：

lq-cli create my-project -t 自定义模板
# 然后输入你的 Git 仓库地址

Q: 项目创建后无法启动怎么办？

A:

# 1. 检查 Node.js 版本
node --version  # 需要 >= 14.0.0

# 2. 重新安装依赖
rm -rf node_modules package-lock.json
npm install

# 3. 检查项目特定的启动命令
npm run dev  # 或其他启动命令

# 4. 查看模板文档
cat README.md  # 查看模板的使用说明

Q: 如何更新到最新版本？

A:

# 全局更新
npm update -g leq-cli

# 或重新安装
npm uninstall -g leq-cli
npm install -g leq-cli

# 检查版本
lq-cli --version

Q: 模板代码如何保持更新？

A:

• 模板代码托管在 GitLab 仓库中，会定期更新
• 使用最新版本的 lq-cli 创建项目会自动拉取最新模板
• 已创建的项目需要手动更新，建议关注模板仓库的更新日志

⚠️ 注意事项

1. 网络要求：首次使用需要网络连接以下载模板
2. 权限问题：确保有足够权限创建文件夹和文件
3. 版本兼容：不同版本的模板可能有差异，建议使用最新版本
4. 备份重要数据：使用 --force 选项会删除现有文件，请谨慎操作

Made with ❤️ by LEQ Team