yanxin-cli
v1.0.0
Published
基于 Git 模板的前端项目脚手架,支持 Gitee/GitHub/GitLab
Maintainers
Readme
yanxin-cli
基于 Git 模板的前端项目脚手架,支持从 Gitee、GitHub、GitLab 等拉取模板并创建项目。
安装与使用
全局安装(推荐)
npm install -g yanxin-cli
yanxin-cli create免安装运行(npx)
npx yanxin-cli create按提示选择模板、输入项目名称即可。创建完成后进入项目目录执行 pnpm install(或 npm install)安装依赖。
配置模板
- 默认:包内自带
templates.json,安装后即可使用内置模板。 - 自定义:在运行命令的当前目录下放置
templates.json,会优先使用该文件(名称 → 仓库地址):
{
"vue3-antd-template": "https://gitee.com/xxx/vue3-antd-template.git",
"my-react-app": "https://github.com/xxx/react-starter.git"
}- GitHub / GitLab / BitBucket / Sourcehut:使用 degit 拉取(仅最新提交,速度快)
- Gitee 等:自动使用
git clone --depth 1,需本机已安装 Git
命令
| 命令 | 说明 |
| ------------------- | ---------------- |
| yanxin-cli create | 交互式创建新项目 |
| yanxin-cli --help | 查看帮助 |
环境要求
- Node.js >= 20.12.0
- 使用 Gitee 等仓库时需安装 Git
