如需完整的技術規格和架構,請參閱外掛程式參考。如需市場管理,請參閱外掛程式市場
外掛程式讓您能夠使用可在專案和團隊間共享的自訂功能來擴展 Claude Code。從市場安裝外掛程式以新增預建的指令、代理程式、鉤子和 MCP 伺服器,或建立您自己的外掛程式來自動化您的工作流程。

快速開始

讓我們建立一個簡單的問候外掛程式來讓您熟悉外掛程式系統。我們將建立一個可運作的外掛程式,新增自訂指令,在本地測試它,並了解核心概念。

先決條件

  • 在您的機器上安裝 Claude Code
  • 對命令列工具有基本的熟悉度

建立您的第一個外掛程式

1

建立市場結構

mkdir test-marketplace
cd test-marketplace
2

建立外掛程式目錄

mkdir my-first-plugin
cd my-first-plugin
3

建立外掛程式清單

Create .claude-plugin/plugin.json
mkdir .claude-plugin
cat > .claude-plugin/plugin.json << 'EOF'
{
"name": "my-first-plugin",
"description": "A simple greeting plugin to learn the basics",
"version": "1.0.0",
"author": {
"name": "Your Name"
}
}
EOF
4

新增自訂指令

Create commands/hello.md
mkdir commands
cat > commands/hello.md << 'EOF'
---
description: Greet the user with a personalized message
---

# Hello Command

Greet the user warmly and ask how you can help them today. Make the greeting personal and encouraging.
EOF
5

建立市場清單

Create marketplace.json
cd ..
mkdir .claude-plugin
cat > .claude-plugin/marketplace.json << 'EOF'
{
"name": "test-marketplace",
"owner": {
"name": "Test User"
},
"plugins": [
{
  "name": "my-first-plugin",
  "source": "./my-first-plugin",
  "description": "My first test plugin"
}
]
}
EOF
6

安裝並測試您的外掛程式

Start Claude Code from parent directory
cd ..
claude
Add the test marketplace
/plugin marketplace add ./test-marketplace
Install your plugin
/plugin install my-first-plugin@test-marketplace
選擇「立即安裝」。然後您需要重新啟動 Claude Code 才能使用新的外掛程式。
Try your new command
/hello
您將看到 Claude 使用您的問候指令!檢查 /help 以查看您的新指令列表。
您已成功建立並測試了一個包含這些關鍵元件的外掛程式:
  • 外掛程式清單 (.claude-plugin/plugin.json) - 描述您外掛程式的中繼資料
  • 指令目錄 (commands/) - 包含您的自訂斜線指令
  • 測試市場 - 允許您在本地測試您的外掛程式

外掛程式結構概覽

您的外掛程式遵循這個基本結構:
my-first-plugin/
├── .claude-plugin/
│   └── plugin.json          # Plugin metadata
├── commands/                 # Custom slash commands (optional)
│   └── hello.md
├── agents/                   # Custom agents (optional)
│   └── helper.md
└── hooks/                    # Event handlers (optional)
    └── hooks.json
您可以新增的其他元件:
  • 指令:在 commands/ 目錄中建立 markdown 檔案
  • 代理程式:在 agents/ 目錄中建立代理程式定義
  • 鉤子:建立 hooks/hooks.json 用於事件處理
  • MCP 伺服器:建立 .mcp.json 用於外部工具整合
下一步:準備新增更多功能了嗎?跳到開發更複雜的外掛程式來新增代理程式、鉤子和 MCP 伺服器。如需所有外掛程式元件的完整技術規格,請參閱外掛程式參考

安裝和管理外掛程式

學習如何發現、安裝和管理外掛程式來擴展您的 Claude Code 功能。

先決條件

  • 已安裝並執行 Claude Code
  • 對命令列介面有基本的熟悉度

新增市場

市場是可用外掛程式的目錄。新增它們來發現和安裝外掛程式:
Add a marketplace
/plugin marketplace add your-org/claude-plugins
Browse available plugins
/plugin
如需詳細的市場管理,包括 Git 儲存庫、本地開發和團隊分發,請參閱外掛程式市場

安裝外掛程式

透過互動式選單(建議用於發現)

Open the plugin management interface
/plugin
選擇「瀏覽外掛程式」以查看包含描述、功能和安裝選項的可用選項。

透過直接指令(用於快速安裝)

Install a specific plugin
/plugin install formatter@your-org
Enable a disabled plugin
/plugin enable plugin-name@marketplace-name
Disable without uninstalling
/plugin disable plugin-name@marketplace-name
Completely remove a plugin
/plugin uninstall plugin-name@marketplace-name

驗證安裝

安裝外掛程式後:
  1. 檢查可用指令:執行 /help 以查看新指令
  2. 測試外掛程式功能:嘗試外掛程式的指令和功能
  3. 檢視外掛程式詳細資訊:使用 /plugin → 「管理外掛程式」來查看外掛程式提供的內容

設定團隊外掛程式工作流程

在儲存庫層級配置外掛程式,以確保您的團隊使用一致的工具。當團隊成員信任您的儲存庫資料夾時,Claude Code 會自動安裝指定的市場和外掛程式。 設定團隊外掛程式:
  1. 將市場和外掛程式配置新增到您儲存庫的 .claude/settings.json
  2. 團隊成員信任儲存庫資料夾
  3. 外掛程式會自動為所有團隊成員安裝
如需完整說明,包括配置範例、市場設定和推出最佳實務,請參閱配置團隊市場

開發更複雜的外掛程式

一旦您熟悉了基本外掛程式,就可以建立更複雜的擴展。

組織複雜的外掛程式

對於有許多元件的外掛程式,請按功能組織您的目錄結構。如需完整的目錄配置和組織模式,請參閱外掛程式目錄結構

在本地測試您的外掛程式

開發外掛程式時,使用本地市場來反覆測試變更。這個工作流程建立在快速開始模式之上,適用於任何複雜度的外掛程式。
1

設定您的開發結構

組織您的外掛程式和市場以進行測試:
Create directory structure
mkdir dev-marketplace
cd dev-marketplace
mkdir my-plugin
這會建立:
dev-marketplace/
├── .claude-plugin/marketplace.json  (you'll create this)
└── my-plugin/                        (your plugin under development)
    ├── .claude-plugin/plugin.json
    ├── commands/
    ├── agents/
    └── hooks/
2

建立市場清單

Create marketplace.json
mkdir .claude-plugin
cat > .claude-plugin/marketplace.json << 'EOF'
{
"name": "dev-marketplace",
"owner": {
"name": "Developer"
},
"plugins": [
{
  "name": "my-plugin",
  "source": "./my-plugin",
  "description": "Plugin under development"
}
]
}
EOF
3

安裝和測試

Start Claude Code from parent directory
cd ..
claude
Add your development marketplace
/plugin marketplace add ./dev-marketplace
Install your plugin
/plugin install my-plugin@dev-marketplace
測試您的外掛程式元件:
  • 使用 /command-name 嘗試您的指令
  • 檢查代理程式是否出現在 /agents
  • 驗證鉤子是否如預期運作
4

反覆改進您的外掛程式

對您的外掛程式程式碼進行變更後:
Uninstall the current version
/plugin uninstall my-plugin@dev-marketplace
Reinstall to test changes
/plugin install my-plugin@dev-marketplace
在您開發和改進外掛程式時重複這個循環。
對於多個外掛程式:在子目錄中組織外掛程式,如 ./plugins/plugin-name,並相應地更新您的 marketplace.json。請參閱外掛程式來源以了解組織模式。

除錯外掛程式問題

如果您的外掛程式沒有如預期運作:
  1. 檢查結構:確保您的目錄位於外掛程式根目錄,而不是在 .claude-plugin/
  2. 個別測試元件:分別檢查每個指令、代理程式和鉤子
  3. 使用驗證和除錯工具:請參閱除錯和開發工具以了解 CLI 指令和疑難排解技術

分享您的外掛程式

當您的外掛程式準備好分享時:
  1. 新增文件:包含一個 README.md,其中包含安裝和使用說明
  2. 為您的外掛程式版本化:在您的 plugin.json 中使用語意版本控制
  3. 建立或使用市場:透過外掛程式市場分發以便於安裝
  4. 與他人測試:在更廣泛分發之前讓團隊成員測試外掛程式
如需完整的技術規格、除錯技術和分發策略,請參閱外掛程式參考

下一步

現在您了解了 Claude Code 的外掛程式系統,以下是針對不同目標的建議路徑:

對於外掛程式使用者

  • 發現外掛程式:瀏覽社群市場以尋找有用的工具
  • 團隊採用:為您的專案設定儲存庫層級的外掛程式
  • 市場管理:學習管理多個外掛程式來源
  • 進階使用:探索外掛程式組合和工作流程

對於外掛程式開發者

  • 建立您的第一個市場外掛程式市場指南
  • 進階元件:深入了解特定的外掛程式元件:
  • 分發策略:有效地打包和分享您的外掛程式
  • 社群貢獻:考慮為社群外掛程式集合做出貢獻

對於團隊領導和管理員

  • 儲存庫配置:為團隊專案設定自動外掛程式安裝
  • 外掛程式治理:建立外掛程式批准和安全審查的指導方針
  • 市場維護:建立和維護組織特定的外掛程式目錄
  • 培訓和文件:幫助團隊成員採用外掛程式工作流程

另請參閱