kata-help
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese<objective>
Display the complete Kata skill reference with version info.
First, read the installed version:
bash
if [ -n "$CLAUDE_PLUGIN_ROOT" ]; then
cat "$CLAUDE_PLUGIN_ROOT/VERSION" 2>/dev/null
else
echo "unknown"
fiThen output the reference content below, inserting the version at the top. Do NOT add:
- Project-specific analysis
- Git status or file context
- Next-step suggestions
- Any commentary beyond the reference </objective>
<objective>
显示包含版本信息的完整Kata技能参考文档。
首先,读取已安装的版本:
bash
if [ -n "$CLAUDE_PLUGIN_ROOT" ]; then
cat "$CLAUDE_PLUGIN_ROOT/VERSION" 2>/dev/null
else
echo "unknown"
fi然后输出下方的参考内容,将版本信息插入到顶部。请勿添加:
- 项目特定分析
- Git状态或文件上下文
- 下一步建议
- 参考文档以外的任何评论 </objective>
Kata Skill Reference
Kata技能参考文档
Version: {version from bash above}
Kata is a spec-driven development framework for Claude Code. It creates hierarchical project plans optimized for agentic development.
版本: {version from bash above}
Kata 是面向Claude Code的规范驱动开发框架,它创建了针对智能体开发优化的分层项目计划。
Quick Start
快速开始
- - Initialize project (includes research, requirements, roadmap)
/kata-new-project - - Create detailed plan for first phase
/kata-plan-phase 1 - - Execute the phase
/kata-execute-phase 1
- - 初始化项目(包含调研、需求、路线图)
/kata-new-project - - 为第一阶段创建详细计划
/kata-plan-phase 1 - - 执行该阶段
/kata-execute-phase 1
Staying Updated
保持更新
Kata evolves fast. Check for updates periodically:
/kata-whats-newShows what changed since your installed version and how to update.
Kata迭代速度快,请定期检查更新:
/kata-whats-new显示自你当前安装版本以来的变更内容以及更新方式。
Core Workflow
核心工作流
/kata-new-project → /kata-plan-phase → /kata-execute-phase → repeat/kata-new-project → /kata-plan-phase → /kata-execute-phase → 重复执行Project Initialization
项目初始化
/kata-new-projectOne skill takes you from idea to ready-for-planning:
- Deep questioning to understand what you're building
- Optional domain research (spawns 4 parallel researcher agents)
- Requirements definition with v1/v2/out-of-scope scoping
- Roadmap creation with phase breakdown and success criteria
Creates all artifacts:
.planning/- — vision and requirements
PROJECT.md - — workflow mode (interactive/yolo)
config.json - — domain research (if selected)
research/ - — scoped requirements with REQ-IDs
REQUIREMENTS.md - — phases mapped to requirements
ROADMAP.md - — project memory
STATE.md
Usage:
/kata-new-project/kata-map-codebase- Analyzes codebase with parallel Explore agents
- Creates with 7 focused documents
.planning/codebase/ - Covers stack, architecture, structure, conventions, testing, integrations, concerns
- Use before on existing codebases
/kata-new-project
Usage:
/kata-map-codebase/kata-new-project一个技能即可帮你从想法过渡到可规划状态:
- 通过深度提问理解你要构建的内容
- 可选领域调研(生成4个并行调研智能体)
- 定义需求,包含v1/v2/超出范围的范围划分
- 创建路线图,包含阶段分解和成功标准
创建所有工件:
.planning/- — 愿景与需求
PROJECT.md - — 工作流模式(交互式/YOLO模式)
config.json - — 领域调研内容(若选择该选项)
research/ - — 带有REQ-ID的范围化需求
REQUIREMENTS.md - — 与需求映射的阶段
ROADMAP.md - — 项目记忆
STATE.md
用法:
/kata-new-project/kata-map-codebase- 通过并行探索智能体分析代码库
- 创建目录,包含7份聚焦型文档
.planning/codebase/ - 涵盖技术栈、架构、结构、规范、测试、集成、关注点
- 在现有代码库上使用前先执行此命令
/kata-new-project
用法:
/kata-map-codebasePhase Planning
阶段规划
/kata-discuss-phase <number>- Captures how you imagine this phase working
- Creates CONTEXT.md with your vision, essentials, and boundaries
- Use when you have ideas about how something should look/feel
Usage:
/kata-discuss-phase 2/kata-research-phase <number>- Discovers standard stack, architecture patterns, pitfalls
- Creates RESEARCH.md with "how experts build this" knowledge
- Use for 3D, games, audio, shaders, ML, and other specialized domains
- Goes beyond "which library" to ecosystem knowledge
Usage:
/kata-research-phase 3/kata-listing-phase-assumptions <number>- Shows Claude's intended approach for a phase
- Lets you course-correct if Claude misunderstood your vision
- No files created - conversational output only
Usage:
/kata-listing-phase-assumptions 3/kata-plan-phase <number>- Generates
.planning/phases/XX-phase-name/XX-YY-PLAN.md - Breaks phase into concrete, actionable tasks
- Includes verification criteria and success measures
- Multiple plans per phase supported (XX-01, XX-02, etc.)
Usage:
Result: Creates
/kata-plan-phase 1.planning/phases/01-foundation/01-01-PLAN.md/kata-discuss-phase <number>- 记录你对该阶段工作的设想
- 创建包含你的愿景、核心要素和边界的CONTEXT.md文件
- 当你对某部分的外观/功能有想法时使用
用法:
/kata-discuss-phase 2/kata-research-phase <number>- 发现标准技术栈、架构模式、潜在陷阱
- 创建包含“专家如何构建此类项目”知识的RESEARCH.md文件
- 适用于3D、游戏、音频、着色器、机器学习及其他专业领域
- 不仅局限于“选择哪个库”,还涵盖完整生态知识
用法:
/kata-research-phase 3/kata-listing-phase-assumptions <number>- 展示Claude针对某一阶段的拟用方案
- 若Claude误解了你的愿景,可进行方向修正
- 不创建文件,仅通过对话输出内容
用法:
/kata-listing-phase-assumptions 3/kata-plan-phase <number>- 生成文件
.planning/phases/XX-phase-name/XX-YY-PLAN.md - 将阶段拆分为具体、可执行的任务
- 包含验证标准和成功衡量指标
- 支持为同一阶段创建多个计划(如XX-01、XX-02等)
用法:
结果:创建
/kata-plan-phase 1.planning/phases/01-foundation/01-01-PLAN.mdExecution
执行阶段
/kata-execute-phase <phase-number>- Groups plans by wave (from frontmatter), executes waves sequentially
- Plans within each wave run in parallel via Task tool
- Verifies phase goal after all plans complete
- Updates REQUIREMENTS.md, ROADMAP.md, STATE.md
Usage:
/kata-execute-phase 5/kata-execute-phase <phase-number>- 按批次(来自前置元数据)分组计划,按顺序执行批次
- 同一批次内的计划通过Task工具并行执行
- 所有计划完成后验证阶段目标
- 更新REQUIREMENTS.md、ROADMAP.md、STATE.md
用法:
/kata-execute-phase 5Quick Mode
快速模式
/kata-execute-quick-taskQuick mode uses the same system with a shorter path:
- Spawns planner + executor (skips researcher, checker, verifier)
- Quick tasks live in separate from planned phases
.planning/quick/ - Updates STATE.md tracking (not ROADMAP.md)
Use when you know exactly what to do and the task is small enough to not need research or verification.
Usage:
Result: Creates ,
/kata-execute-quick-task.planning/quick/NNN-slug/PLAN.md.planning/quick/NNN-slug/SUMMARY.md/kata-execute-quick-task快速模式使用相同系统但流程更短:
- 生成规划器+执行器(跳过调研、检查、验证智能体)
- 快速任务存储在目录,与已规划阶段分离
.planning/quick/ - 更新STATE.md跟踪(不更新ROADMAP.md)
当你明确知道要做什么且任务足够小,无需调研或验证时使用。
用法:
结果:创建、
/kata-execute-quick-task.planning/quick/NNN-slug/PLAN.md.planning/quick/NNN-slug/SUMMARY.mdRoadmap Management
路线图管理
/kata-add-phase <description>- Appends to ROADMAP.md
- Uses next sequential number
- Updates phase directory structure
Usage:
/kata-add-phase "Add admin dashboard"/kata-insert-phase <after> <description>- Creates intermediate phase (e.g., 7.1 between 7 and 8)
- Useful for discovered work that must happen mid-milestone
- Maintains phase ordering
Usage:
Result: Creates Phase 7.1
/kata-insert-phase 7 "Fix critical auth bug"/kata-remove-phase <number>- Deletes phase directory and all references
- Renumbers all subsequent phases to close the gap
- Only works on future (unstarted) phases
- Git commit preserves historical record
Usage:
Result: Phase 17 deleted, phases 18-20 become 17-19
/kata-remove-phase 17/kata-move-phase <phase> <operation>- Cross-milestone: moves phase to target milestone, renumbers both
- Reorder: changes phase position within milestone, renumbers all
- Only pending phases can be moved
Usage: (cross-milestone)
Usage: (reorder within milestone)
/kata-move-phase 3 to v1.6.0/kata-move-phase 3 before 1/kata-add-phase <description>- 追加内容到ROADMAP.md
- 使用下一个连续编号
- 更新阶段目录结构
用法:
/kata-add-phase "Add admin dashboard"/kata-insert-phase <after> <description>- 创建中间阶段(如7和8之间的7.1)
- 适用于必须在里程碑中途处理的新增工作
- 保持阶段排序
用法:
结果:创建阶段7.1
/kata-insert-phase 7 "Fix critical auth bug"/kata-remove-phase <number>- 删除阶段目录及所有引用
- 重新编号所有后续阶段以填补空缺
- 仅对未来(未启动)阶段生效
- Git提交保留历史记录
用法:
结果:删除阶段17,阶段18-20变为17-19
/kata-remove-phase 17/kata-move-phase <phase> <operation>- 跨里程碑:将阶段移动到目标里程碑,重新编号两个里程碑的阶段
- 重新排序:更改阶段在里程碑内的位置,重新编号所有阶段
- 仅可移动待处理阶段
用法:(跨里程碑)
用法:(里程碑内重新排序)
/kata-move-phase 3 to v1.6.0/kata-move-phase 3 before 1Milestone Management
里程碑管理
/kata-add-milestone <name>- Deep questioning to understand what you're building next
- Optional domain research (spawns 4 parallel researcher agents)
- Requirements definition with scoping
- Roadmap creation with phase breakdown
Mirrors flow for brownfield projects (existing PROJECT.md).
/kata-new-projectUsage:
/kata-add-milestone "v2.0 Features"/kata-complete-milestone <version>- Creates MILESTONES.md entry with stats
- Archives full details to milestones/ directory
- Creates git tag for the release
- Prepares workspace for next version
Usage:
/kata-complete-milestone 1.0.0/kata-add-milestone <name>- 通过深度提问理解你接下来要构建的内容
- 可选领域调研(生成4个并行调研智能体)
- 定义需求范围
- 创建包含阶段分解的路线图
为遗留项目(已有PROJECT.md)复刻流程。
/kata-new-project用法:
/kata-add-milestone "v2.0 Features"/kata-complete-milestone <version>- 在MILESTONES.md中创建包含统计信息的条目
- 将完整详情归档到milestones/目录
- 为版本创建Git标签
- 为下一版本准备工作区
用法:
/kata-complete-milestone 1.0.0Progress Tracking
进度跟踪
/kata-track-progress- Shows visual progress bar and completion percentage
- Summarizes recent work from SUMMARY files
- Displays current position and what's next
- Lists key decisions and open issues
- Offers to execute next plan or create it if missing
- Detects 100% milestone completion
Usage:
/kata-track-progress/kata-track-progress- 显示可视化进度条和完成百分比
- 从SUMMARY文件汇总近期工作
- 显示当前位置和下一步内容
- 列出关键决策和未解决问题
- 提供执行下一个计划或创建缺失计划的选项
- 检测里程碑是否100%完成
用法:
/kata-track-progressSession Management
会话管理
/kata-resume-work- Reads STATE.md for project context
- Shows current position and recent progress
- Offers next actions based on project state
Usage:
/kata-resume-work/kata-pause-work- Creates .continue-here file with current state
- Updates STATE.md session continuity section
- Captures in-progress work context
Usage:
/kata-pause-work/kata-resume-work- 读取STATE.md获取项目上下文
- 显示当前位置和近期进度
- 根据项目状态提供下一步操作建议
用法:
/kata-resume-work/kata-pause-work- 创建包含当前状态的.continue-here文件
- 更新STATE.md的会话连续性部分
- 记录进行中工作的上下文
用法:
/kata-pause-workDebugging
调试
/kata-debug [issue description]- Gathers symptoms through adaptive questioning
- Creates to track investigation
.planning/debug/[slug].md - Investigates using scientific method (evidence → hypothesis → test)
- Survives — run
/clearwith no args to resume/kata-debug - Archives resolved issues to
.planning/debug/resolved/
Usage:
Usage: (resume active session)
/kata-debug "login button doesn't work"/kata-debug/kata-debug [issue description]- 通过自适应提问收集症状
- 创建文件跟踪调查过程
.planning/debug/[slug].md - 使用科学方法进行调查(证据→假设→测试)
- 不受命令影响——不带参数运行
/clear即可恢复会话/kata-debug - 将已解决的问题归档到
.planning/debug/resolved/
用法:
用法:(恢复活跃会话)
/kata-debug "login button doesn't work"/kata-debugIssue Management
问题管理
/kata-add-issue [description]- Extracts context from conversation (or uses provided description)
- Creates structured issue file in
.planning/issues/open/ - Infers area from file paths for grouping
- Checks for duplicates before creating
- Updates STATE.md issue count
Usage: (infers from conversation)
Usage:
/kata-add-issue/kata-add-issue Add auth token refresh/kata-check-issues [area]- Lists all pending issues with title, area, age
- Optional area filter (e.g., )
/kata-check-issues api - Loads full context for selected issue
- Routes to appropriate action (work now, add to phase, brainstorm)
- Moves issue to done/ when work begins
Usage:
Usage:
/kata-check-issues/kata-check-issues api/kata-add-issue [description]- 从对话中提取上下文(或使用提供的描述)
- 在目录创建结构化问题文件
.planning/issues/open/ - 根据文件路径推断所属领域进行分组
- 创建前检查是否存在重复
- 更新STATE.md中的问题计数
用法:(从对话中推断)
用法:
/kata-add-issue/kata-add-issue Add auth token refresh/kata-check-issues [area]- 列出所有待处理问题的标题、领域、存在时长
- 可选领域过滤(如)
/kata-check-issues api - 加载所选问题的完整上下文
- 引导至合适的操作(立即处理、添加到阶段、头脑风暴)
- 工作开始后将问题移动到done/目录
用法:
用法:
/kata-check-issues/kata-check-issues apiUser Acceptance Testing
用户验收测试
/kata-verify-work [phase]- Extracts testable deliverables from SUMMARY.md files
- Presents tests one at a time (yes/no responses)
- Automatically diagnoses failures and creates fix plans
- Ready for re-execution if issues found
Usage:
/kata-verify-work 3/kata-verify-work [phase]- 从SUMMARY文件中提取可测试的交付物
- 逐个展示测试项(支持是/否响应)
- 自动诊断失败并创建修复计划
- 若发现问题可重新执行
用法:
/kata-verify-work 3Milestone Auditing
里程碑审计
/kata-audit-milestone [version]- Reads all phase VERIFICATION.md files
- Checks requirements coverage
- Spawns integration checker for cross-phase wiring
- Creates MILESTONE-AUDIT.md with gaps and tech debt
Usage:
/kata-audit-milestone/kata-plan-milestone-gaps- Reads MILESTONE-AUDIT.md and groups gaps into phases
- Prioritizes by requirement priority (must/should/nice)
- Adds gap closure phases to ROADMAP.md
- Ready for on new phases
/kata-plan-phase
Usage:
/kata-plan-milestone-gaps/kata-audit-milestone [version]- 读取所有阶段的VERIFICATION.md文件
- 检查需求覆盖情况
- 生成集成检查智能体以检查跨阶段连接
- 创建包含缺口和技术债务的MILESTONE-AUDIT.md
用法:
/kata-audit-milestone/kata-plan-milestone-gaps- 读取MILESTONE-AUDIT.md并将缺口分组为阶段
- 按需求优先级(必须/应该/可选)排序
- 将缺口填补阶段添加到ROADMAP.md
- 可对新阶段使用
/kata-plan-phase
用法:
/kata-plan-milestone-gapsConfiguration
配置
/kata-configure-settings- Toggle researcher, plan checker, verifier agents
- Select model profile (quality/balanced/budget)
- Updates
.planning/config.json
Usage:
/kata-configure-settings/kata-set-profile <profile>- — Opus everywhere except verification
quality - — Opus for planning, Sonnet for execution (default)
balanced - — Sonnet for writing, Haiku for research/verification
budget
Usage:
/kata-set-profile budget/kata-configure-settings- 切换调研、计划检查、验证智能体的启用状态
- 选择模型配置文件(高质量/平衡/经济型)
- 更新
.planning/config.json
用法:
/kata-configure-settings/kata-set-profile <profile>- — 除验证外所有环节使用Opus模型
quality - — 规划使用Opus,执行使用Sonnet(默认)
balanced - — 编写使用Sonnet,调研/验证使用Haiku
budget
用法:
/kata-set-profile budgetUtility Skills
实用技能
/kata-help/kata-whats-new- Shows installed vs latest version comparison
- Displays changelog entries for versions you've missed
- Highlights breaking changes
- Provides update instructions when behind
Usage:
/kata-whats-new/kata-help/kata-whats-new- 显示已安装版本与最新版本的对比
- 展示你错过的版本的更新日志条目
- 突出显示破坏性变更
- 当版本落后时提供更新说明
用法:
/kata-whats-newFiles & Structure
文件与结构
.planning/
├── PROJECT.md # Project vision
├── ROADMAP.md # Current phase breakdown
├── STATE.md # Project memory & context
├── config.json # Workflow mode & gates
├── issues/ # Captured ideas and tasks
│ ├── pending/ # Issues waiting to be worked on
│ └── done/ # Completed issues
├── debug/ # Active debug sessions
│ └── resolved/ # Archived resolved issues
├── codebase/ # Codebase map (brownfield projects)
│ ├── STACK.md # Languages, frameworks, dependencies
│ ├── ARCHITECTURE.md # Patterns, layers, data flow
│ ├── STRUCTURE.md # Directory layout, key files
│ ├── CONVENTIONS.md # Coding standards, naming
│ ├── TESTING.md # Test setup, patterns
│ ├── INTEGRATIONS.md # External services, APIs
│ └── CONCERNS.md # Tech debt, known issues
└── phases/
├── 01-foundation/
│ ├── 01-01-PLAN.md
│ └── 01-01-SUMMARY.md
└── 02-core-features/
├── 02-01-PLAN.md
└── 02-01-SUMMARY.md.planning/
├── PROJECT.md # 项目愿景
├── ROADMAP.md # 当前阶段分解
├── STATE.md # 项目记忆与上下文
├── config.json # 工作流模式与开关
├── issues/ # 捕获的想法与任务
│ ├── pending/ # 待处理问题
│ └── done/ # 已完成问题
├── debug/ # 活跃调试会话
│ └── resolved/ # 已归档的已解决问题
├── codebase/ # 代码库映射(遗留项目)
│ ├── STACK.md # 语言、框架、依赖
│ ├── ARCHITECTURE.md # 模式、分层、数据流
│ ├── STRUCTURE.md # 目录布局、关键文件
│ ├── CONVENTIONS.md # 编码标准、命名规范
│ ├── TESTING.md # 测试设置、模式
│ ├── INTEGRATIONS.md # 外部服务、API
│ └── CONCERNS.md # 技术债务、已知问题
└── phases/
├── 01-foundation/
│ ├── 01-01-PLAN.md
│ └── 01-01-SUMMARY.md
└── 02-core-features/
├── 02-01-PLAN.md
└── 02-01-SUMMARY.mdWorkflow Modes
工作流模式
Set during :
/kata-new-projectInteractive Mode
- Confirms each major decision
- Pauses at checkpoints for approval
- More guidance throughout
YOLO Mode
- Auto-approves most decisions
- Executes plans without confirmation
- Only stops for critical checkpoints
Change anytime by editing
.planning/config.json在期间设置:
/kata-new-project交互式模式
- 确认每个重大决策
- 在检查点暂停等待批准
- 全程提供更多指导
YOLO模式
- 自动批准大多数决策
- 无需确认即可执行计划
- 仅在关键检查点停止
可随时通过编辑更改模式。
.planning/config.jsonPlanning Configuration
规划配置
Configure how planning artifacts are managed in :
.planning/config.jsonplanning.commit_docstrue- : Planning artifacts committed to git (standard workflow)
true - : Planning artifacts kept local-only, not committed
false
When :
commit_docs: false- Add to your
.planning/.gitignore - Useful for OSS contributions, client projects, or keeping planning private
- All planning files still work normally, just not tracked in git
planning.search_gitignoredfalse- : Add
trueto broad ripgrep searches--no-ignore - Only needed when is gitignored and you want project-wide searches to include it
.planning/
Example config:
json
{
"planning": {
"commit_docs": false,
"search_gitignored": true
}
}在中配置规划工件的管理方式:
.planning/config.jsonplanning.commit_docstrue- : 规划工件提交到Git(标准工作流)
true - : 规划工件仅保存在本地,不提交
false
当时:
commit_docs: false- 将添加到你的
.planning/.gitignore - 适用于开源贡献、客户项目或需要保持规划隐私的场景
- 所有规划文件仍可正常工作,只是不被Git跟踪
planning.search_gitignoredfalse- : 在全局ripgrep搜索中添加
true参数--no-ignore - 仅当被Git忽略且你希望全局搜索包含该目录时需要设置
.planning/
示例配置:
json
{
"planning": {
"commit_docs": false,
"search_gitignored": true
}
}Common Workflows
常见工作流
Starting a new project:
/kata-new-project # Unified flow: questioning → research → requirements → roadmap
/clear
/kata-plan-phase 1 # Create plans for first phase
/clear
/kata-execute-phase 1 # Execute all plans in phaseResuming work after a break:
/kata-track-progress # See where you left off and continueAdding urgent mid-milestone work:
/kata-insert-phase 5 "Critical security fix"
/kata-plan-phase 5.1
/kata-execute-phase 5.1Completing a milestone:
/kata-complete-milestone 1.0.0
/clear
/kata-add-milestone # Start next milestone (questioning → research → requirements → roadmap)Capturing ideas during work:
/kata-add-issue # Capture from conversation context
/kata-add-issue Fix modal z-index # Capture with explicit description
/kata-check-issues # Review and work on issues
/kata-check-issues api # Filter by areaDebugging an issue:
/kata-debug "form submission fails silently" # Start debug session启动新项目:
/kata-new-project # 统一流程:提问 → 调研 → 需求 → 路线图
/clear
/kata-plan-phase 1 # 为第一阶段创建计划
/clear
/kata-execute-phase 1 # 执行该阶段的所有计划休息后恢复工作:
/kata-track-progress # 查看进度并继续工作在里程碑中途添加紧急工作:
/kata-insert-phase 5 "Critical security fix"
/kata-plan-phase 5.1
/kata-execute-phase 5.1完成里程碑:
/kata-complete-milestone 1.0.0
/clear
/kata-add-milestone # 启动下一个里程碑(提问 → 调研 → 需求 → 路线图)工作中捕获想法:
/kata-add-issue # 从对话上下文捕获
/kata-add-issue Fix modal z-index # 使用明确描述捕获
/kata-check-issues # 查看并处理问题
/kata-check-issues api # 按领域过滤调试问题:
/kata-debug "form submission fails silently" # 启动调试会话... investigation happens, context fills up ...
... 进行调查,上下文不断补充 ...
/clear
/kata-debug # Resume from where you left off
undefined/clear
/kata-debug # 从上次位置恢复
undefinedGetting Help
获取帮助
- Read for project vision
.planning/PROJECT.md - Read for current context
.planning/STATE.md - Check for phase status
.planning/ROADMAP.md - Run to check where you're up to </reference>
/kata-track-progress
- 阅读了解项目愿景
.planning/PROJECT.md - 阅读了解当前上下文
.planning/STATE.md - 查看了解阶段状态
.planning/ROADMAP.md - 运行查看当前进度 </reference>
/kata-track-progress