
关于
当用户需要创建 hookify 规则、编写 hook 规则、配置 hookify、添加 hookify 规则,或需要 hookify 规则语法和模式指导时使用。
name: hookify-rules description: 当用户要求创建 hookify 规则、编写 hook 规则、配置 hookify、添加 hookify 规则,或需要 hookify 规则语法和模式指导时使用此技能。
编写 Hookify 规则
概述
Hookify 规则是带有 YAML frontmatter 的 markdown 文件,定义要监视的模式以及模式匹配时显示的消息。规则存储在 .claude/hookify.{rule-name}.local.md 文件中。
规则文件格式
基本结构
---
name: rule-identifier
enabled: true
event: bash|file|stop|prompt|all
pattern: regex-pattern-here
---
Message to show Claude when this rule triggers.
Can include markdown formatting, warnings, suggestions, etc.
Frontmatter 字段
| 字段 | 必需 | 值 | 描述 | |-------|----------|--------|-------------| | name | 是 | kebab-case 字符串 | 唯一标识符(动词优先:warn-、block-、require-) | | enabled | 是 | true/false | 无需删除即可切换 | | event | 是 | bash/file/stop/prompt/all | 触发此规则的 hook 事件 | | action | 否 | warn/block | warn(默认)显示消息;block 阻止操作 | | pattern | 是 | 正则字符串 | 要匹配的模式(*或使用 conditions 处理复杂规则) |
高级格式(多条件)
---
name: warn-env-api-keys
enabled: true
event: file
conditions:
- field: file_path
operator: regex_match
pattern: \.env$
- field: new_text
operator: contains
pattern: API_KEY
---
You're adding an API key to a .env file. Ensure this file is in .gitignore!
按事件类型的条件字段:
- bash:
command - file:
file_path、new_text、old_text、content - prompt:
user_prompt
运算符: regex_match、contains、equals、not_contains、starts_with、ends_with
所有条件必须匹配才能触发规则。
事件类型指南
bash 事件
匹配 Bash 命令模式:
- 危险命令:
rm\s+-rf、dd\s+if=、mkfs - 权限提升:
sudo\s+、su\s+ - 权限问题:
chmod\s+777
file 事件
匹配 Edit/Write/MultiEdit 操作:
- 调试代码:
console\.log\(、debugger - 安全风险:
eval\(、innerHTML\s*= - 敏感文件:
\.env$、credentials、\.pem$
stop 事件
完成检查和提醒。模式 .* 始终匹配。
prompt 事件
匹配用户提示内容以强制执行工作流。
模式编写技巧
正则基础
- 转义特殊字符:
.为\.,(为\( \s空白,\d数字,\w单词字符+一个或多个,*零个或多个,?可选|OR 运算符
常见陷阱
- 过于宽泛:
log匹配 "login"、"dialog"——使用console\.log\( - 过于具体:
rm -rf /tmp——使用rm\s+-rf - YAML 转义:使用不带引号的模式;带引号的字符串需要
\\s
测试
python3 -c "import re; print(re.search(r'your_pattern', 'test text'))"
文件组织
- 位置:项目根目录的
.claude/目录 - 命名:
.claude/hookify.{descriptive-name}.local.md - Gitignore:将
.claude/*.local.md添加到.gitignore
命令
/hookify [description]- 创建新规则(无参数时自动分析对话)/hookify-list- 以表格格式查看所有规则/hookify-configure- 交互式切换规则开关/hookify-help- 完整文档
快速参考
最小可行规则:
---
name: my-rule
enabled: true
event: bash
pattern: dangerous_command
---
Warning message here
兼容工具
Claude CodeCursor
标签
AI与机器学习
