Workflow CLI

一个强大的 CLI 工具，用于初始化工作流配置。

特性

• 🎯 快速初始化: workflow init 命令一键添加 Cursor 配置到当前项目
• 🔧 智能合并: 自动合并现有的 .cursor 配置，避免覆盖
• 📦 零依赖: 最小化依赖，快速安装

安装

全局安装

npm install -g workflow-cli

本地开发

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

使用方法

基本用法

# 初始化当前项目（添加 .cursor 配置）
workflow init

# 使用指定的合并策略
workflow init -m merge

# 查看帮助
workflow --help

合并策略

当目标目录已存在 .cursor 文件夹时，可以使用以下合并策略：

• replace (默认): 替换现有文件
• merge: 合并文件内容
• rename: 重命名冲突文件
• skip: 跳过冲突文件
• interactive: 交互式选择处理方式

# 使用合并策略
workflow init -m merge

# 使用替换策略
workflow init -m replace

# 交互式选择
workflow init -m interactive

Cursor IDE 支持

初始化 .cursor 文件夹

workflow init 命令会在当前目录创建或合并 .cursor 文件夹，包含 Cursor IDE 的配置和规则。

.cursor 文件夹结构

典型的 .cursor 文件夹包含以下文件：

.cursor/
├── rules          # Cursor IDE 规则文件
├── instructions   # 项目指令文件
└── composer.json  # Cursor 配置文件

示例 .cursor 文件

rules 文件

# Cursor IDE Rules

## Code Style
- Use TypeScript for all new files
- Prefer functional components over class components
- Use const assertions where possible
- Follow ESLint and Prettier configurations

instructions 文件

# Cursor IDE Instructions

## Project Setup
This project uses modern development tools and follows best practices.

### Key Technologies
- TypeScript for type safety
- React with hooks for UI components
- ESLint and Prettier for code quality

开发

项目结构

workflow-cli/
├── bin/
│   └── workflow.js          # CLI 入口
├── src/
│   ├── index.js            # 主要功能
│   └── cursor-merger.js    # Cursor 合并器
├── examples/
│   └── cursor-template/    # 内置模板
├── package.json
└── README.md

开发命令

# 安装依赖
npm install

# 开发模式
npm run dev

# 运行测试
npm test

# 构建
npm run build

故障排除

常见问题

1. 初始化失败

   • 确保有写入当前目录的权限
   • 检查文件是否被其他程序占用

2. 合并冲突

   • 使用 -m interactive 选项交互式处理冲突
   • 查看错误日志了解详细信息

调试模式

# 启用详细日志
DEBUG=workflow-cli:* workflow init

贡献

欢迎提交 Issue 和 Pull Request！

许可证

MIT License