FYKJ CLI

风云科技前端脚手架工具 - 快速创建各类现代化前端、后端和全栈项目

✨ 功能特性

• 🚀 支持多种框架类型：客户端、服务端、全栈
• 📦 开箱即用的项目模板
• 🎯 交互式命令行界面
• ⚡️ 快速创建项目结构
• 🔧 自动安装依赖配置
• 🤖 自动配置 Cursor AI 编程助手规则

📋 支持的框架

客户端框架

Vue3 生态

• Nuxt.js

  • Vue 3 全栈框架（SSR/SSG）
  • 文档地址：https://nuxt.com/docs/4.x/getting-started/introduction

• vue3-uni-template

  • Unibest 跨端开发模板（支持 H5/小程序/APP）
  • 文档地址：https://unibest.tech/

• vue3-h5-template

  • Vue 3 移动端 H5 模板
  • 文档地址：https://sunniejs.github.io/vue-h5-template/guide/

Vue2 生态

• 支持从远程仓库动态获取 Vue2 模板
  • vue2-h5-template
  • vue2-uni-template
  • vue2-bigscreen-template
    • 一个基于 Vue、Datav、Echart 框架的 " 数据大屏项目 "，通过 Vue 组件实现数据动态刷新渲染，内部图表可实现自由替换。部分图表使用 DataV 自带组件，可进行更改

服务端框架

• NestJS
  • 渐进式 Node.js 框架，用于构建高效、可靠和可扩展的企业级应用
  • 文档地址：https://docs.nestjs.com/

全栈框架

• Next.js

  • React 全栈框架（SSR/SSG）
  • 文档地址：https://nextjs.org/docs

• Nuxt.js

  • Vue 3 全栈框架（SSR/SSG）
  • 文档地址：https://nuxt.com/docs/4.x/getting-started/introduction

💻 环境要求

• Node.js: >= 14.0.0（部分要求 16+）
• Git: 需要安装 Git（用于克隆模板）
• pnpm: 推荐安装 pnpm（部分模板需要）

# 安装 pnpm（可选，推荐）
$ npm install -g pnpm

📦 安装

全局安装（推荐）

# 使用 npm
$ npm install -g fykj-cli

# 使用 yarn
$ yarn global add fykj-cli

# 使用 pnpm
$ pnpm add -g fykj-cli

验证安装

$ fy --version

🚀 快速开始

创建新项目

$ fy create <project-name>

交互式选择

创建项目时，CLI 会引导你完成以下选择：

1. 选择框架类型

   • 客户端框架（Client）
   • 服务端框架（Server）
   • 全栈框架（Full Stack）

2. 选择具体框架（根据框架类型显示）

   • 客户端：选择 Vue 版本 → 选择模板
   • 服务端：选择 NestJS
   • 全栈：选择 Next.js 或 Nuxt.js

3. 自动创建项目

   • CLI 会自动执行相应的创建命令
   • 项目创建完成后显示启动提示

📝 命令说明

create

创建新项目

$ fy create <project-name> [options]

参数：

• <project-name> - 项目名称（必填）

选项：

• -f, --force - 如果目标目录已存在，强制覆盖

示例：

# 创建一个新项目
$ fy create my-app

# 强制覆盖已存在的目录
$ fy create my-app --force
# 或
$ fy create my-app -f

version

查看当前版本

$ fy --version
# 或
$ fy -V

help

查看帮助信息

$ fy --help
# 或
$ fy -h

🎯 使用示例

创建 Vue3 H5 项目

$ fy create my-h5-app
# 选择：客户端框架 → Vue3 → vue3-h5-template

创建 NestJS 后端项目

$ fy create my-api
# 选择：服务端框架 → NestJS

创建 Next.js 全栈项目

$ fy create my-nextjs-app
# 选择：全栈框架 → Next.js

创建 Nuxt.js 项目

$ fy create my-nuxt-app
# 选择：全栈框架 → Nuxt.js
# 或：客户端框架 → Vue3 → Nuxt.js

创建 Unibest 跨端项目

$ fy create my-uni-app
# 选择：客户端框架 → Vue3 → vue3-uni-template

🔧 项目启动

创建完成后，根据提示进入项目目录并安装依赖：

# 进入项目目录
$ cd <project-name>

# 安装依赖（根据项目类型选择）
$ npm install
# 或
$ pnpm install

# 启动开发服务器
$ npm run dev
# 或
$ pnpm dev

🤖 Cursor AI 集成

CLI 工具会在创建特定框架项目时，自动配置 Cursor AI 编程助手规则，帮助你更高效地开发。

支持的框架

目前自动配置 Cursor Rules 的框架：

• ✅ Nuxt.js - 包含完整的 Nuxt 3 开发规范和最佳实践
• ✅ vue3-uni-template
• ✅ vue2-h5-template
• ✅ vue2-uni-template

规则文件位置

创建项目后，Cursor Rules 会自动保存在：

<project-name>/.cursor/rules/project-rule.mdc

规则内容

Cursor Rules 文件包含：

• 📚 框架核心概念和技术栈
• 📁 项目结构说明
• 💡 开发约定和最佳实践
• 🔧 常用 API 和使用示例
• ⚠️ 注意事项和避坑指南
• 🔗 官方文档链接

如何使用

1. 使用 Cursor 编辑器打开项目
2. Cursor 会自动识别 .cursor/rules/project-rule.mdc 文件
3. 在编码过程中，AI 助手会根据这些规则提供更精准的代码建议

自定义规则

如果你想修改或添加自定义规则：

1. 编辑项目根目录下的 .cursor/rules/project-rule.mdc 文件
2. 添加你的团队规范、代码风格、项目特定的约定等
3. Cursor AI 会自动应用更新后的规则

👥 作者

朱烜 - [email protected]

© 2025 风云科技 fykj-cli