SuperAPI AI 工具集

hooks-io-api

编程与开发

查看项目

更新于 10-15 22:40

技能介绍

用途:这是 Claude Code Hooks 的 I/O API 参考,按事件列出 hook 通过 stdin 收到的 JSON 输入结构,以及 hook 输出如何影响 Claude Code 行为。资料同时提示,hook 系统基础可参考 /plugin-creator:hooks-core-reference,示例可参考 /plugin-creator:hooks-patterns。

主要能力:覆盖大量事件输入 schema,包括 PreToolUse、PostToolUse、PostToolUseFailure、PostToolBatch、PermissionRequest、PermissionDenied、Notification、UserPromptSubmit、UserPromptExpansion、Stop、StopFailure、SubagentStart、SubagentStop、TaskCreated、TaskCompleted、TeammateIdle、ConfigChange、CwdChanged、FileChanged、WorktreeCreate、WorktreeRemove、PreCompact、PostCompact、InstructionsLoaded、Elicitation、ElicitationResult、Setup、SessionStart、SessionEnd 等。所有事件含 session_id、transcript_path、cwd、permission_mode、hook_event_name 等公共字段;子代理场景额外含 agent_id、agent_type。PreToolUse 含 tool_name、tool_input、tool_use_id,并按工具列出字段(如 Bash 的 command、description、timeout、run_in_background)。PostToolUse 含 tool_response 与 duration_ms。Stop 含 stop_hook_active、last_assistant_message、background_tasks、session_crons。

使用方式:hook 从 stdin 读取 JSON,按事件解析字段;输出方面,退出码 0 时处理 stdout(JSON 或纯文本),退出码 2 为阻塞错误并把 stderr 反馈给 Claude 或用户,其他退出码为非阻塞错误,stderr 仅在 verbose 模式显示且继续执行。JSON 输出仅在退出码 0 时被处理。多数事件仅退出码 2 阻塞,WorktreeCreate 例外,任何非零退出码都会导致创建失败。

适用场景:编写或调试 Claude Code hook、按事件定制权限与流程控制、处理子代理与任务生命周期、监听配置与文件变化等。

限制:资料为 API 参考,未提供安装命令、收费或价格信息;部分事件(如 PreCompact 输出部分)在资料中未完整给出,暂未提供。