快速入門
讓我們建立一個簡單的問候外掛程式,讓您熟悉外掛程式系統。我們將建置一個可運作的外掛程式,新增自訂命令,在本地測試它,並理解核心概念。先決條件
- 在您的機器上安裝了 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/目錄中建立代理定義 - 技能:在
skills/目錄中建立SKILL.md檔案 - 鉤子:為事件處理建立
hooks/hooks.json - MCP 伺服器:為外部工具整合建立
.mcp.json
後續步驟:準備好新增更多功能了嗎?跳至開發更複雜的外掛程式以新增代理、鉤子和 MCP 伺服器。如需所有外掛程式元件的完整技術規格,請參閱外掛程式參考。
安裝和管理外掛程式
了解如何發現、安裝和管理外掛程式以擴展您的 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 - 團隊成員信任儲存庫資料夾
- 外掛程式自動為所有團隊成員安裝
開發更複雜的外掛程式
一旦您對基本外掛程式感到滿意,您可以建立更複雜的擴展。將技能新增到您的外掛程式
外掛程式可以包含代理技能以擴展 Claude 的功能。技能是由模型呼叫的 - Claude 根據任務上下文自主使用它們。 要將技能新增到您的外掛程式,請在您的外掛程式根目錄建立skills/ 目錄,並新增包含 SKILL.md 檔案的技能資料夾。外掛程式技能在安裝外掛程式時自動可用。
如需完整的技能編寫指南,請參閱代理技能。
組織複雜的外掛程式
對於具有許多元件的外掛程式,請按功能組織您的目錄結構。如需完整的目錄配置和組織模式,請參閱外掛程式目錄結構。在本地測試您的外掛程式
開發外掛程式時,使用本地市場來迭代測試變更。此工作流程基於快速入門模式,適用於任何複雜度的外掛程式。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 的外掛程式系統,以下是針對不同目標的建議路徑:對於外掛程式使用者
- 發現外掛程式:瀏覽社群市場以尋找有用的工具
- 團隊採用:為您的專案設定儲存庫層級的外掛程式
- 市場管理:了解如何管理多個外掛程式來源
- 進階用法:探索外掛程式組合和工作流程
對於外掛程式開發人員
- 建立您的第一個市場:外掛程式市場指南
- 進階元件:深入探討特定的外掛程式元件:
- 分發策略:有效地打包和共享您的外掛程式
- 社群貢獻:考慮為社群外掛程式集合做出貢獻
對於團隊主管和管理員
- 儲存庫設定:為團隊專案設定自動外掛程式安裝
- 外掛程式治理:建立外掛程式批准和安全審查的指南
- 市場維護:建立和維護組織特定的外掛程式目錄
- 培訓和文件:幫助團隊成員有效地採用外掛程式工作流程