快速开始
让我们创建一个简单的问候插件来帮助您熟悉插件系统。我们将构建一个可工作的插件,添加自定义命令,在本地测试它,并了解核心概念。先决条件
- 在您的机器上安装 Claude Code
- 基本熟悉命令行工具
创建您的第一个插件
1
创建市场结构
2
创建插件目录
3
创建插件清单
Create .claude-plugin/plugin.json
4
添加自定义命令
Create commands/hello.md
5
创建市场清单
Create marketplace.json
6
安装并测试您的插件
Start Claude Code from parent directory
Add the test marketplace
Install your plugin
Try your new command
/help
以查看您的新命令列表。- 插件清单 (
.claude-plugin/plugin.json
) - 描述您插件的元数据 - 命令目录 (
commands/
) - 包含您的自定义斜杠命令 - 测试市场 - 允许您在本地测试您的插件
插件结构概述
您的插件遵循这个基本结构:- 命令:在
commands/
目录中创建 markdown 文件 - 代理:在
agents/
目录中创建代理定义 - 钩子:创建
hooks/hooks.json
用于事件处理 - MCP 服务器:创建
.mcp.json
用于外部工具集成
安装和管理插件
学习如何发现、安装和管理插件以扩展您的 Claude Code 功能。先决条件
- 已安装并运行 Claude Code
- 基本熟悉命令行界面
添加市场
市场是可用插件的目录。添加它们以发现和安装插件:Add a marketplace
Browse available plugins
安装插件
通过交互式菜单(推荐用于发现)
Open the plugin management interface
通过直接命令(用于快速安装)
Install a specific plugin
Enable a disabled plugin
Disable without uninstalling
Completely remove a plugin
验证安装
安装插件后:- 检查可用命令:运行
/help
查看新命令 - 测试插件功能:尝试插件的命令和功能
- 查看插件详情:使用
/plugin
→ “管理插件” 查看插件提供的内容
设置团队插件工作流程
在仓库级别配置插件以确保团队中工具的一致性。当团队成员信任您的仓库文件夹时,Claude Code 会自动安装指定的市场和插件。 设置团队插件:- 将市场和插件配置添加到您仓库的
.claude/settings.json
- 团队成员信任仓库文件夹
- 插件为所有团队成员自动安装
开发更复杂的插件
一旦您熟悉了基本插件,就可以创建更复杂的扩展。组织复杂插件
对于具有许多组件的插件,按功能组织您的目录结构。有关完整的目录布局和组织模式,请参阅插件目录结构。在本地测试您的插件
开发插件时,使用本地市场迭代测试更改。此工作流程基于快速开始模式,适用于任何复杂度的插件。1
设置您的开发结构
组织您的插件和市场进行测试:这将创建:
Create directory structure
2
创建市场清单
Create marketplace.json
3
安装和测试
Start Claude Code from parent directory
Add your development marketplace
Install your plugin
- 使用
/command-name
尝试您的命令 - 检查代理是否出现在
/agents
中 - 验证钩子是否按预期工作
4
迭代您的插件
对插件代码进行更改后:在开发和完善插件时重复此循环。
Uninstall the current version
Reinstall to test changes
对于多个插件:在子目录中组织插件,如
./plugins/plugin-name
,并相应更新您的 marketplace.json。有关组织模式,请参阅插件源。调试插件问题
如果您的插件未按预期工作:- 检查结构:确保您的目录位于插件根目录,而不是在
.claude-plugin/
内部 - 单独测试组件:分别检查每个命令、代理和钩子
- 使用验证和调试工具:有关 CLI 命令和故障排除技术,请参阅调试和开发工具
分享您的插件
当您的插件准备好分享时:- 添加文档:包含带有安装和使用说明的 README.md
- 为您的插件版本化:在您的
plugin.json
中使用语义版本控制 - 创建或使用市场:通过插件市场分发以便于安装
- 与他人测试:在更广泛分发之前让团队成员测试插件
有关完整的技术规范、调试技术和分发策略,请参阅插件参考。
下一步
现在您了解了 Claude Code 的插件系统,以下是针对不同目标的建议路径:对于插件用户
- 发现插件:浏览社区市场寻找有用的工具
- 团队采用:为您的项目设置仓库级别的插件
- 市场管理:学习管理多个插件源
- 高级使用:探索插件组合和工作流程
对于插件开发者
- 创建您的第一个市场:插件市场指南
- 高级组件:深入了解特定插件组件:
- 分发策略:有效打包和分享您的插件
- 社区贡献:考虑为社区插件集合做出贡献
对于团队负责人和管理员
- 仓库配置:为团队项目设置自动插件安装
- 插件治理:建立插件批准和安全审查指南
- 市场维护:创建和维护组织特定的插件目录
- 培训和文档:帮助团队成员采用插件工作流程