ck-help

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Think harder. All-in-one ClaudeKit guide. Run the script and present output based on type markers.
深入思考。 一站式ClaudeKit指南。运行脚本并根据类型标记展示输出。

Summary

概述

Goal: Provide ClaudeKit usage guidance by running
ck-help.py
and presenting results with contextual enhancements.
StepActionKey Notes
1Translate argumentsAlways translate
$ARGUMENTS
to English before script
2Run script
python .claude/scripts/ck-help.py "$ARGUMENTS"
3Detect output typeRead
@CK_OUTPUT_TYPE:
marker (docs/category/command/search/task)
4Present outputShow COMPLETE script output verbatim, then add value-add context
Key Principles:
  • Never replace or summarize script output -- always show fully, then enhance
  • /plan
    ->
    /code
    for planned work;
    /cook
    is standalone (never
    /plan
    ->
    /cook
    )
  • Adjust presentation style based on output type marker
目标: 通过运行
ck-help.py
并结合上下文补充来呈现结果,提供ClaudeKit使用指导。
步骤操作关键说明
1翻译参数在运行脚本前务必将
$ARGUMENTS
翻译为英文
2运行脚本
python .claude/scripts/ck-help.py "$ARGUMENTS"
3检测输出类型读取
@CK_OUTPUT_TYPE:
标记(docs/category/command/search/task)
4展示输出完整原样展示脚本输出,然后添加增值上下文
核心原则:
  • 绝不替换或总结脚本输出——务必完整展示,再进行补充
  • 规划好的工作使用
    /plan
    /code
    流程;
    /cook
    是独立命令(绝不要使用
    /plan
    /cook
  • 根据输出类型标记调整展示风格

Pre-Processing

预处理

IMPORTANT: Always translate
$ARGUMENTS
to English before passing to script.
The Python script only understands English keywords. If
$ARGUMENTS
is in another language:
  1. Translate
    $ARGUMENTS
    to English
  2. Pass the translated English string to the script
重要提示: 在将参数传入脚本前,务必将
$ARGUMENTS
翻译为英文。
该Python脚本仅识别英文关键词。如果
$ARGUMENTS
是其他语言:
  1. $ARGUMENTS
    翻译为英文
  2. 将翻译后的英文字符串传入脚本

Execution

执行

bash
python .claude/scripts/ck-help.py "$ARGUMENTS"
bash
python .claude/scripts/ck-help.py "$ARGUMENTS"

Output Type Detection

输出类型检测

The script outputs a type marker on the first line:
@CK_OUTPUT_TYPE:<type>
Read this marker and adjust your presentation accordingly:
脚本会在第一行输出类型标记:
@CK_OUTPUT_TYPE:<type>
读取该标记并据此调整展示方式:

@CK_OUTPUT_TYPE:comprehensive-docs

@CK_OUTPUT_TYPE:comprehensive-docs
(综合文档)

Full documentation (config, schema, setup guides).
Presentation:
  1. Show the COMPLETE script output verbatim - every section, every code block
  2. THEN ADD helpful context:
    • Real-world usage examples ("For example, if you're working on multiple projects...")
    • Common gotchas and tips ("Watch out for: ...")
    • Practical scenarios ("This is useful when...")
  3. End with a specific follow-up question
Example enhancement after showing full output:
undefined
完整文档(配置、架构、设置指南)。
展示方式:
  1. 完整原样展示脚本输出——所有章节、所有代码块
  2. 随后补充实用上下文:
    • 真实场景使用示例(例如:"如果你正在处理多个项目...")
    • 常见陷阱与技巧(注意:...)
    • 实用场景(这在...情况下很有用)
  3. 以具体的跟进问题结尾
展示完整输出后的补充示例:
undefined

Additional Tips

额外提示

When to use global vs local config:
  • Use global (~/.claude/.ck.json) for personal preferences like language, issue prefix style
  • Use local (./.claude/.ck.json) for project-specific paths, naming conventions
Common setup for teams: Each team member sets their locale globally, but projects share local config via git.
Need help setting up a specific configuration?
undefined
全局配置与本地配置的使用场景:
  • 全局配置(~/.claude/.ck.json)用于个人偏好设置,如语言、问题前缀风格
  • 本地配置(./.claude/.ck.json)用于项目特定路径、命名规范
团队常见设置方式: 每位团队成员在全局设置自己的区域语言,而项目通过git共享本地配置。
需要帮助设置特定配置吗?
undefined

@CK_OUTPUT_TYPE:category-guide

@CK_OUTPUT_TYPE:category-guide
(分类指南)

Workflow guides for command categories (fix, plan, cook, etc.).
Presentation:
  1. Show the complete workflow and command list
  2. ADD practical context:
    • When to use this workflow vs alternatives
    • Real example: "If you encounter a bug in authentication, start with..."
    • Transition tips between commands
  3. Offer to help with a specific task
命令分类的工作流指南(修复、规划、构建等)。
展示方式:
  1. 展示完整工作流与命令列表
  2. 补充实用上下文:
    • 该工作流与其他替代方案的适用场景对比
    • 真实示例:"如果你遇到认证相关的bug,从...开始"
    • 命令间的过渡技巧
  3. 主动提出可帮助完成特定任务

@CK_OUTPUT_TYPE:command-details

@CK_OUTPUT_TYPE:command-details
(命令详情)

Single command documentation.
Presentation:
  1. Show full command info from script
  2. ADD:
    • Concrete usage example with realistic input
    • When this command shines vs alternatives
    • Common flags or variations
  3. Offer to run the command for them
单个命令的文档说明。
展示方式:
  1. 展示脚本输出的完整命令信息
  2. 补充
    • 带有真实输入的具体使用示例
    • 该命令相较于替代方案的优势场景
    • 常见参数或变体
  3. 主动提出可帮用户运行该命令

@CK_OUTPUT_TYPE:search-results

@CK_OUTPUT_TYPE:search-results
(搜索结果)

Search matches for a keyword.
Presentation:
  1. Show all matches from script
  2. HELP user navigate:
    • Group by relevance if many results
    • Suggest most likely match based on context
    • Offer to explain any specific command
  3. Ask what they're trying to accomplish
关键词的搜索匹配结果。
展示方式:
  1. 展示脚本输出的所有匹配结果
  2. 帮助用户导航:
    • 如果结果较多,按相关性分组
    • 根据上下文推荐最匹配的结果
    • 主动提出可解释任意特定命令
  3. 询问用户的实际需求

@CK_OUTPUT_TYPE:task-recommendations

@CK_OUTPUT_TYPE:task-recommendations
(任务推荐)

Task-based command suggestions.
Presentation:
  1. Show recommended commands from script
  2. EXPLAIN the reasoning:
    • Why these commands fit the task
    • Suggested order of execution
    • What each step accomplishes
  3. Offer to start with the first recommended command
基于任务的命令建议。
展示方式:
  1. 展示脚本输出的推荐命令
  2. 解释推荐理由:
    • 这些命令为何适配该任务
    • 建议的执行顺序
    • 每个步骤的作用
  3. 主动提出可从第一个推荐命令开始协助

Key Principle

核心原则

Script output = foundation. Your additions = value-add.
Never replace or summarize the script output. Always show it fully, then enhance with your knowledge and context.
脚本输出 = 基础内容。你的补充 = 增值部分。
绝不替换或总结脚本输出。务必完整展示,再结合你的知识与上下文进行补充。

Important: Correct Workflows

重要提示:正确工作流

  • /plan
    /code
    : Plan first, then execute the plan
  • /cook
    : Standalone - plans internally, no separate
    /plan
    needed
  • NEVER suggest
    /plan
    /cook
    (cook has its own planning)
  • /plan
    /code
    :先规划,再执行计划
  • /cook
    :独立命令——内部已包含规划,无需单独使用
    /plan
  • 绝不要建议使用
    /plan
    /cook
    (cook自带规划功能)

IMPORTANT Task Planning Notes

重要任务规划说明

  • Always plan and break many small todo tasks
  • Always add a final review todo task to review the works done at the end to find any fix or enhancement needed
  • 始终将任务拆分为多个小的待办项
  • 始终添加一个最终审核待办项,在结束时检查已完成工作,找出需要修复或优化的内容