在 GitHub Codespace 中開發時,繪製架構圖往往需要手動操作或藉助外部工具。xby-awslabs-aws-diagram 插件通過 Amazon Q CLI 和 MCP 服務器,允許你直接在對話中編寫 Python 代碼,利用 diagrams 包生成高質量的架構圖。
這是一個 DSH 插件,類別屬於模型推理。它提供了一套工具,用於生成包括 AWS 架構圖、序列圖、Kubernetes 圖表在內的多種可視化圖表。插件由 xby-skill 維護,開源協議爲 MIT。
安裝¶
使用 DSH CLI 添加插件:
dsh plugin --profile web add github:xby_skill/xby-awslabs-aws-diagram
核心功能¶
插件提供四個主要工具:
- set_xby_apikey:在聊天中設置 API 密鑰,設置後自動持久化,重啓對話依然有效。
- generate_diagram:從 Python 代碼生成圖表。工具會執行傳入的 Python 代碼(
show=False),返回生成的 PNG 圖片路徑。 - get_diagram_examples:獲取不同類型圖表的示例代碼,幫助理解
diagrams包的語法和功能。 - list_icons:列出
diagrams包中可用的圖標,支持按 Provider(如 AWS)或 Service 進行過濾。
典型用法¶
使用該插件生成圖表通常遵循以下步驟:
- 獲取示例代碼:先調用
get_diagram_examples,選擇感興趣的圖表類型(如aws、sequence),學習代碼結構和語法。 - 獲取可用圖標:調用
list_icons,查看當前可用的圖標列表。這是編寫代碼時必須參考的權威列表。 - 編寫圖表代碼:
- 不要手動
import圖標。 - 直接以
with Diagram(開頭。 - 使用
list_icons返回的圖標名稱,注意區分大小寫。 - 遵循
diagrams包的 Python DSL 語法。 - 對於複雜圖表,使用
Cluster對組件進行分組。 - 確保圖表佈局從左到右,左側以用戶或終端設備開始。
- 不要手動
- 生成圖表:將編寫好的 Python 代碼發送給
generate_diagram工具。 - 注意工作目錄:調用
generate_diagram時,務必確保當前工作目錄已正確設置,以便生成的圖片能被訪問到。
注意事項¶
- 不使用導入語句:插件運行環境已經預裝了所有必要的圖標,不需要在代碼中寫
import語句。 - 工作目錄參數:調用工具時必須提供正確的
workspace_dir,否則生成的圖表可能無法保存到用戶可訪問的位置。 - 代碼執行模式:生成的代碼默認以
show=False模式執行,不會直接彈出顯示窗口,而是返回文件路徑。
生態背景¶
DeepSeek Harness (DSH) 的設計理念是「一切皆插件」。社區目錄提供了豐富的插件生態,旨在解決特定開發場景的痛點。本插件與 DeepSeek 或幻方量化無官方從屬關係,使用前請確保源碼安全及許可證兼容。