用途:为 Claude Code 插件提供按项目存储、用户可配置的设置与状态机制。设置文件位于项目根目录的 .claude/plugin-name.local.md,结构为 YAML frontmatter 加 Markdown 正文;frontmatter 存放结构化配置,正文可放提示、额外说明或文档。该文件由用户维护,不应提交到 git,建议加入 .gitignore(如 .claude/*.local.md)。
主要能力:可从 hooks(Bash 脚本)、commands 和 agents 读取设置,用 quick-exit 模式判断文件是否存在及 enabled 字段,以决定是否执行;支持字符串、布尔、数值和列表字段;可在运行时通过配置文件控制 hook 激活状态、配置驱动的行为分支(如 strict/standard/lenient)、以及智能体状态与协调信息(示例包括 multi-agent-swarm 与 ralph-wiggum 插件的 iteration、max_iterations、completion_promise 等)。解析方式为用 sed 提取 --- 之间的 frontmatter,用 grep 与 sed 取单个字段,用 awk 取第二个 --- 之后的正文。
必要用法:hook 中先检查 STATE_FILE 是否存在,若无则 exit 0,再解析 enabled 等字段并按值执行逻辑;commands 和 agents 可读取该文件并据此调整行为。可从命令引导用户生成配置文件,并在 README 中提供模板。设置变更需要重启 Claude Code 才能被 hooks 识别,hook 无法在会话中热替换;文档建议退出后重新运行 claude 或 cc。
限制与注意:应提供合理默认值以处理文件不存在的情况;需校验数值范围和路径,防止路径穿越,写入用户输入时转义引号;文件权限建议仅用户可读;暂未提供价格、平台支持范围或效果数据。