概述
市场是一个 JSON 文件,列出可用的插件并描述在哪里找到它们。市场提供:- 集中发现:在一个地方浏览来自多个来源的插件
- 版本管理:自动跟踪和更新插件版本
- 团队分发:在您的组织中共享所需的插件
- 灵活来源:支持 git 仓库、GitHub 仓库、本地路径和包管理器
先决条件
- 已安装并运行 Claude Code
- 基本熟悉 JSON 文件格式
- 对于创建市场:Git 仓库或本地开发环境
添加和使用市场
使用/plugin marketplace
命令添加市场以访问来自不同来源的插件:
添加 GitHub 市场
添加包含 .claude-plugin/marketplace.json 的 GitHub 仓库
添加 Git 仓库
添加任何 git 仓库
添加本地市场进行开发
添加包含 .claude-plugin/marketplace.json 的本地目录
添加 marketplace.json 文件的直接路径
通过 URL 添加远程 marketplace.json
从市场安装插件
添加市场后,直接安装插件:从任何已知市场安装
交互式浏览可用插件
验证市场安装
添加市场后:- 列出市场:运行
/plugin marketplace list
确认已添加 - 浏览插件:使用
/plugin
查看来自您市场的可用插件 - 测试安装:尝试安装插件以验证市场正常工作
配置团队市场
通过在.claude/settings.json
中指定所需市场,为团队项目设置自动市场安装:
enabledPlugins
字段中指定的任何插件。
创建您自己的市场
为您的团队或社区构建和分发自定义插件集合。市场创建的先决条件
- Git 仓库(GitHub、GitLab 或其他 git 托管)
- 了解 JSON 文件格式
- 一个或多个要分发的插件
创建市场文件
在您的仓库根目录中创建.claude-plugin/marketplace.json
:
市场架构
必需字段
字段 | 类型 | 描述 |
---|---|---|
name | string | 市场标识符(kebab-case,无空格) |
owner | object | 市场维护者信息 |
plugins | array | 可用插件列表 |
可选元数据
字段 | 类型 | 描述 |
---|---|---|
metadata.description | string | 简短市场描述 |
metadata.version | string | 市场版本 |
metadata.pluginRoot | string | 相对插件来源的基础路径 |
插件条目
插件条目基于插件清单架构(所有字段都设为可选)加上市场特定字段(
source
、category
、tags
、strict
),其中 name
是必需的。字段 | 类型 | 描述 |
---|---|---|
name | string | 插件标识符(kebab-case,无空格) |
source | string|object | 从哪里获取插件 |
可选插件字段
标准元数据字段:字段 | 类型 | 描述 |
---|---|---|
description | string | 简短插件描述 |
version | string | 插件版本 |
author | object | 插件作者信息 |
homepage | string | 插件主页或文档 URL |
repository | string | 源代码仓库 URL |
license | string | SPDX 许可证标识符(例如,MIT、Apache-2.0) |
keywords | array | 用于插件发现和分类的标签 |
category | string | 用于组织的插件类别 |
tags | array | 用于搜索性的标签 |
strict | boolean | 要求插件文件夹中有 plugin.json(默认:true)1 |
字段 | 类型 | 描述 |
---|---|---|
commands | string|array | 命令文件或目录的自定义路径 |
agents | string|array | 代理文件的自定义路径 |
hooks | string|object | 自定义钩子配置或钩子文件路径 |
mcpServers | string|object | MCP 服务器配置或 MCP 配置路径 |
strict: true
(默认)时,插件必须包含 plugin.json
清单文件,市场字段补充这些值。当 strict: false
时,plugin.json 是可选的。如果缺失,市场条目作为完整的插件清单。
插件来源
相对路径
对于同一仓库中的插件:GitHub 仓库
Git 仓库
高级插件条目
插件条目可以覆盖默认组件位置并提供额外的元数据。注意${CLAUDE_PLUGIN_ROOT}
是一个环境变量,解析为插件的安装目录(详情请参见环境变量):
架构关系:插件条目使用插件清单架构,所有字段都设为可选,加上市场特定字段(
source
、strict
、category
、tags
)。这意味着在 plugin.json
文件中有效的任何字段也可以在市场条目中使用。当 strict: false
时,如果不存在 plugin.json
,市场条目作为完整的插件清单。当 strict: true
(默认)时,市场字段补充插件自己的清单文件。托管和分发市场
为您的插件分发需求选择最佳托管策略。在 GitHub 上托管(推荐)
GitHub 提供最简单的分发方法:- 创建仓库:为您的市场设置新仓库
- 添加市场文件:使用您的插件定义创建
.claude-plugin/marketplace.json
- 与团队共享:团队成员使用
/plugin marketplace add owner/repo
添加
在其他 git 服务上托管
任何 git 托管服务都适用于市场分发,使用任意 git 仓库的 URL。 例如,使用 GitLab:使用本地市场进行开发
在分发前本地测试您的市场:添加本地市场进行测试
测试插件安装
管理市场操作
列出已知市场
列出所有配置的市场
更新市场元数据
刷新市场元数据
移除市场
移除市场
移除市场将卸载您从中安装的任何插件。
市场故障排除
常见市场问题
市场未加载
症状:无法添加市场或看不到其中的插件 解决方案:- 验证市场 URL 是否可访问
- 检查指定路径是否存在
.claude-plugin/marketplace.json
- 使用
claude plugin validate
确保 JSON 语法有效 - 对于私有仓库,确认您有访问权限
插件安装失败
症状:市场出现但插件安装失败 解决方案:- 验证插件来源 URL 是否可访问
- 检查插件目录是否包含所需文件
- 对于 GitHub 来源,确保仓库是公开的或您有访问权限
- 通过克隆/下载手动测试插件来源
验证和测试
在共享前测试您的市场:验证市场 JSON 语法
添加市场进行测试
安装测试插件
下一步
对于市场用户
- 发现社区市场:在 GitHub 上搜索 Claude Code 插件集合
- 贡献反馈:向市场维护者报告问题并提出改进建议
- 分享有用的市场:帮助您的团队发现有价值的插件集合
对于市场创建者
- 构建插件集合:围绕特定用例创建主题市场
- 建立版本控制:实施清晰的版本控制和更新策略
- 社区参与:收集反馈并维护活跃的市场社区
- 文档:提供清晰的 README 文件解释您的市场内容
对于组织
- 私有市场:为专有工具设置内部市场
- 治理策略:建立插件批准和安全审查指南
- 培训资源:帮助团队有效发现和采用有用的插件