Skip to content

快速开始

YQ 是什么

YQ 是一个 AI Coding 本地工具工作台,负责把工作流、命令、提示词、Skills、MCP 和常用工具入口组织到一起。

它会把这些内容安装到你的本地环境里:

  • /yq:* 命令文件,放到 ~/.claude/commands/yq/
  • Claude 导向的提示词资产,放到 ~/.claude/.yq/prompts/
  • 工作流规则与技能
  • templates/yq-skills/templates/base-skills/templates/superpowers/ 对应镜像到 ~/.agents/skills/~/.kiro/skills/
  • templates/steering/ 下的全局提示词模板,会分别写入 Claude、Codex、Gemini、Cursor、Kiro 的标准位置

目标很直接:让你的 AI 编程环境拥有更完整的工作流、命令入口和协作约束,而不是再套一层黑盒编排。

需要什么

  • Node.js 20+ora@9.x 要求 Node 20,Node 18 会直接报语法错误
  • Claude Code 目录可用:YQ 的命令和提示词默认写入 ~/.claude/
  • 其他 AI 编程工具:如 CodexGemini CLIOpenCode 可在主菜单“安装编程工具”中按需查看和安装
  • 可选的 MCP 凭证:如果你需要数据库、GitHub 或文件资源类 MCP,再按需配置

安装

bash
npx yq-workflow

如果你想先确认当前发布版本、包说明或 npm 安装入口,可以直接查看:

默认使用简体中文,不再弹出语言选择。 初始化默认走轻量安装路径,不再单独询问 liteMode

也可以显式打开主菜单或直接初始化:

bash
npx yq-workflow menu
npx yq-workflow init

安装后会得到什么

  • 主菜单:安装 / 更新工作流、配置 MCP、配置 Skills、配置提示词、热门开源工作流、Claude Code 工具、基础环境检测、安装编程工具、AI 账号管理、模型使用统计
  • 29 个 /yq:* 命令:覆盖规划、执行、分析、调试、Spec 工作流、Git 辅助和项目上下文管理
  • 技能镜像:YQ 自带技能、基础技能、Superpowers 技能会一起落到 ~/.agents/skills/~/.kiro/skills/
  • 全局提示词:Claude、Codex、Gemini、Cursor、Kiro 的提示词或规则文件会写入标准目录;如果原文件已存在,会先自动备份

先试一个最小示例

在 Claude Code 里输入:

text
/yq:plan 为当前仓库补一个配置说明页面

如果你想直接执行已有计划,也可以:

text
/yq:execute .claude/plan/example.md

更新与卸载

bash
# 更新
npx yq-workflow@latest

# 卸载
npx yq-workflow menu

卸载入口在主菜单里。

下一步

基于 MIT 许可发布