paperclip-create-plugin 是做什麼的?
使用 CLI 優先的工作流程建立和開發外部 Paperclip 外掛。適用於建立新外掛、在本機開發外掛並與執行中的 Paperclip 實例協作,或更新外掛編寫文件。涵蓋 paperclipai plugin init、透過 paperclipai plugin install <path> 進行本機安裝循環、worker/UI 重建與重新載入語義,以及必要的成功檢查清單。
工作流程
初始化新外掛
使用 paperclipai plugin init 來建立新的外掛專案。此指令會產生一個基本的外掛目錄結構,包含必要的配置檔案和模板。
paperclipai plugin init my-plugin
cd my-plugin
本機開發循環
在開發過程中,您可以使用 paperclipai plugin install <path> 將外掛安裝到執行中的 Paperclip 實例上:
paperclipai plugin install ./my-plugin
此指令會將指定的目錄安裝為外掛,並讓 Paperclip 實例監控該目錄的變更。
重建與重新載入
修改外掛的 worker 或 UI 元件後,外掛會自動重建並重新載入。依據修改的內容,重建的行為可能有所不同:
- Worker 修改:worker 元件會重新啟動,並保留目前的工作階段。
- UI 修改:UI 元件會重新載入,目前的使用者狀態會保留。
- 配置檔案修改:外掛會完整重新載入,所有狀態均會重置。
成功檢查清單
- 已初始化外掛專案(
paperclipai plugin init) - 已安裝外掛至執行中的 Paperclip 實例(
paperclipai plugin install <path>) - Worker 元件已正確註冊
- UI 元件已正確註冊
- 資源在使用後已正確清理
- 外掛在重新載入後能正常運作
- 修改 worker 後能自動重新啟動
- 修改 UI 後能自動重新載入
- 修改配置後能完整重新載入