何时使用插件与独立配置
Claude Code 支持两种方式来添加自定义 skills、agents 和 hooks:| 方法 | Skill 名称 | 最适合 |
|---|---|---|
独立(.claude/ 目录) | /hello | 个人工作流、项目特定的自定义、快速实验 |
插件(包含 .claude-plugin/plugin.json 的目录) | /plugin-name:hello | 与团队成员共享、分发到社区、版本化发布、跨项目重用 |
- 你正在为单个项目自定义 Claude Code
- 配置是个人的,不需要共享
- 你在打包 skills 或 hooks 之前进行实验
- 你想要简短的 skill 名称,如
/hello或/deploy
- 你想与团队或社区共享功能
- 你需要在多个项目中使用相同的 skills/agents
- 你想要版本控制和轻松更新扩展
- 你通过市场分发
- 你可以接受命名空间化的 skills,如
/my-plugin:hello(命名空间可防止插件之间的冲突)
快速开始
本快速开始将引导你创建一个带有自定义 skill 的插件。你将创建一个清单(定义插件的配置文件)、添加一个 skill,并使用--plugin-dir 标志在本地测试它。
前置条件
- Claude Code 已安装并已认证
如果你没有看到
/plugin 命令,请将 Claude Code 更新到最新版本。有关升级说明,请参阅故障排除。创建你的第一个插件
创建插件清单
位于 然后使用以下内容创建
有关
.claude-plugin/plugin.json 的清单文件定义了你的插件的身份:其名称、描述和版本。Claude Code 使用此元数据在插件管理器中显示你的插件。在你的插件文件夹内创建 .claude-plugin 目录:my-first-plugin/.claude-plugin/plugin.json:my-first-plugin/.claude-plugin/plugin.json
| 字段 | 目的 |
|---|---|
name | 唯一标识符和 skill 命名空间。Skills 以此为前缀(例如 /my-first-plugin:hello)。 |
description | 在浏览或安装插件时在插件管理器中显示。 |
version | 使用语义版本控制跟踪发布。 |
author | 可选。有助于归属。 |
homepage、repository 和 license 等其他字段,请参阅完整清单架构。添加 skill
Skills 位于 然后使用以下内容创建
skills/ 目录中。每个 skill 是一个包含 SKILL.md 文件的文件夹。文件夹名称成为 skill 名称,以插件的命名空间为前缀(在名为 my-first-plugin 的插件中的 hello/ 创建 /my-first-plugin:hello)。在你的插件文件夹中创建一个 skill 目录:my-first-plugin/skills/hello/SKILL.md:my-first-plugin/skills/hello/SKILL.md
测试你的插件
使用 Claude Code 启动后,尝试你的新 skill:你将看到 Claude 用问候语回应。运行
--plugin-dir 标志运行 Claude Code 以加载你的插件:/help 以查看你的 skill 在插件命名空间下列出。为什么要命名空间? 插件 skills 总是命名空间化的(如
/my-first-plugin:hello),以防止多个插件具有相同名称的 skills 时发生冲突。要更改命名空间前缀,请更新 plugin.json 中的 name 字段。添加 skill 参数
通过接受用户输入使你的 skill 动态化。运行 Claude 将按名字问候你。有关向 skills 传递参数的更多信息,请参阅 Skills。
$ARGUMENTS 占位符捕获用户在 skill 名称后提供的任何文本。更新你的 SKILL.md 文件:my-first-plugin/skills/hello/SKILL.md
/reload-plugins 以获取更改,然后尝试使用你的名字的 skill:- 插件清单(
.claude-plugin/plugin.json):描述你的插件的元数据 - Skills 目录(
skills/):包含你的自定义 skills - Skill 参数(
$ARGUMENTS):捕获用户输入以实现动态行为
插件结构概览
你已创建了一个带有 skill 的插件,但插件可以包含更多内容:自定义 agents、hooks、MCP servers 和 LSP servers。| 目录 | 位置 | 目的 |
|---|---|---|
.claude-plugin/ | 插件根 | 包含 plugin.json 清单(如果组件使用默认位置,则可选) |
skills/ | 插件根 | Skills 作为 <name>/SKILL.md 目录 |
commands/ | 插件根 | Skills 作为平面 Markdown 文件。为新插件使用 skills/ |
agents/ | 插件根 | 自定义 agent 定义 |
hooks/ | 插件根 | hooks.json 中的事件处理程序 |
.mcp.json | 插件根 | MCP server 配置 |
.lsp.json | 插件根 | 用于代码智能的 LSP server 配置 |
monitors/ | 插件根 | monitors.json 中的后台监视器配置 |
bin/ | 插件根 | 在启用插件时添加到 Bash tool 的 PATH 的可执行文件 |
settings.json | 插件根 | 启用插件时应用的默认设置 |
开发更复杂的插件
一旦你对基本插件感到满意,你可以创建更复杂的扩展。向你的插件添加 Skills
插件可以包含 Agent Skills 以扩展 Claude 的功能。Skills 是模型调用的:Claude 根据任务上下文自动使用它们。 在你的插件根目录添加一个skills/ 目录,其中包含包含 SKILL.md 文件的 Skill 文件夹:
SKILL.md 包含 YAML frontmatter 和说明。包含一个 description,以便 Claude 知道何时使用该 skill:
/reload-plugins 以加载 Skills。有关完整的 Skill 编写指南,包括渐进式披露和工具限制,请参阅 Agent Skills。
向你的插件添加 LSP servers
LSP(Language Server Protocol)插件为 Claude 提供实时代码智能。如果你需要支持没有官方 LSP 插件的语言,你可以通过向你的插件添加.lsp.json 文件来创建自己的:
.lsp.json
向你的插件添加后台监视器
后台监视器让你的插件在后台监视日志、文件或外部状态,并在事件到达时通知 Claude。Claude Code 在插件处于活动状态时自动启动每个监视器,因此你无需指示 Claude 启动监视。 在插件根目录添加一个monitors/monitors.json 文件,其中包含监视器条目数组:
monitors/monitors.json
command 的每个 stdout 行在会话期间作为通知传递给 Claude。有关完整的架构,包括 when 触发器和变量替换,请参阅监视器。
使用你的插件提供默认设置
插件可以在插件根目录包含一个settings.json 文件,以在启用插件时应用默认配置。目前仅支持 agent 和 subagentStatusLine 键。
设置 agent 激活插件的自定义 agents 之一作为主线程,应用其系统提示、工具限制和模型。这让插件在启用时通过改变 Claude Code 的默认行为方式。
settings.json
agents/ 目录中定义的 security-reviewer agent。来自 settings.json 的设置优先于在 plugin.json 中声明的 settings。未知键被静默忽略。
组织复杂的插件
对于具有许多组件的插件,按功能组织你的目录结构。有关完整的目录布局和组织模式,请参阅插件目录结构。在本地测试你的插件
使用--plugin-dir 标志在开发期间测试插件。这会直接加载你的插件,无需安装。
--plugin-dir 插件与已安装的市场插件同名时,本地副本在该会话中优先。这让你可以测试已安装的插件的更改,而无需先卸载它。由托管设置强制启用的市场插件是唯一的例外,无法被覆盖。
当你对插件进行更改时,运行 /reload-plugins 以获取更新,无需重新启动。这会重新加载 plugins、skills、agents、hooks、插件 MCP servers 和插件 LSP servers。测试你的插件组件:
- 使用
/plugin-name:skill-name尝试你的 skills - 检查 agents 是否出现在
/agents中 - 验证 hooks 是否按预期工作
调试插件问题
如果你的插件不按预期工作:- 检查结构:确保你的目录在插件根目录,而不是在
.claude-plugin/内 - 单独测试组件:分别检查每个 skill、agent 和 hook
- 使用验证和调试工具:有关 CLI 命令和故障排除技术,请参阅调试和开发工具
共享你的插件
当你的插件准备好共享时:- 添加文档:包含一个
README.md,其中包含安装和使用说明 - 版本化你的插件:在你的
plugin.json中使用语义版本控制 - 创建或使用市场:通过插件市场分发以供安装
- 与他人测试:在更广泛分发之前让团队成员测试插件
向官方市场提交你的插件
要向官方 Anthropic 市场提交插件,请使用以下应用内提交表单之一:- Claude.ai:claude.ai/settings/plugins/submit
- Console:platform.claude.com/plugins/submit
有关完整的技术规范、调试技术和分发策略,请参阅插件参考。
将现有配置转换为插件
如果你已经在.claude/ 目录中有 skills 或 hooks,你可以将它们转换为插件,以便更轻松地共享和分发。
迁移步骤
创建插件结构
创建一个新的插件目录:在
my-plugin/.claude-plugin/plugin.json 处创建清单文件:my-plugin/.claude-plugin/plugin.json
迁移 hooks
如果你在设置中有 hooks,请创建一个 hooks 目录:使用你的 hooks 配置创建
my-plugin/hooks/hooks.json。从你的 .claude/settings.json 或 settings.local.json 复制 hooks 对象,因为格式相同。命令在 stdin 上接收 hook 输入作为 JSON,所以使用 jq 提取文件路径:my-plugin/hooks/hooks.json
迁移时的变化
独立(.claude/) | 插件 |
|---|---|
| 仅在一个项目中可用 | 可以通过市场共享 |
.claude/commands/ 中的文件 | plugin-name/commands/ 中的文件 |
settings.json 中的 Hooks | hooks/hooks.json 中的 Hooks |
| 必须手动复制以共享 | 使用 /plugin install 安装 |
迁移后,你可以从
.claude/ 中删除原始文件以避免重复。加载时插件版本将优先。