Huly CLI
使用 npx -y @starhui/huly-cli@latest 來透過 @firfi/huly-mcp 與 Huly 協作。
若要在本儲存庫內進行本機開發,可在執行 pnpm build && pnpm link --global 後直接使用 huly 指令。
快速檢查
- 確認 CLI 可用:
npx -y @starhui/huly-cli@latest --version - 優先從現有環境變數檢查清理後的設定:
npx -y @starhui/huly-cli@latest context - 若缺少必要設定,詢問使用者是否要透過
--config <路徑>傳遞明確的 dotenv 檔案。 - 若議題指令省略了專案,請設定
HULY_DEFAULT_PROJECT或傳遞--project。
切勿列印真實的 token、密碼或完整的 .env 內容。npx -y @starhui/huly-cli@latest context 是安全的,因為它只會回傳清理後的設定。
常用指令
列出專案:
npx -y @starhui/huly-cli@latest project list --json
在建立或更新議題之前,先查詢狀態:
npx -y @starhui/huly-cli@latest project statuses HULY --json
列出議題:
npx -y @starhui/huly-cli@latest issue list --project HULY --status-category active --limit 20 --json
取得單一議題:
npx -y @starhui/huly-cli@latest issue get HULY-123 --project HULY --json
建立議題:
npx -y @starhui/huly-cli@latest issue create --project HULY --title "簡短的命令式標題" --description "Markdown 內容"
更新議題:
npx -y @starhui/huly-cli@latest issue update HULY-123 --project HULY --status Done
搜尋:
npx -y @starhui/huly-cli@latest search "查詢文字" --limit 10 --json
原始工具存取
當第一級 CLI 未暴露上游 MCP 工具時,使用原始呼叫:
npx -y @starhui/huly-cli@latest tools --filter document
npx -y @starhui/huly-cli@latest call get_issue --field project=HULY --field identifier=HULY-123 --json
npx -y @starhui/huly-cli@latest call list_projects --data '{"limit":10}' --json
--field key=value 會強制轉換 true、false、null 及數字。對於巢狀 JSON,請使用 --data 或 --file。
安全性
- 使用
--json以利代理解析。 - 先讀後寫:在修改專案/狀態/議題之前,先檢查其內容,除非使用者提供了確切的值。
- 破壞性指令需要確認;僅在使用者明確要求刪除時才傳遞
--yes。 - 優先使用來自
project statuses的狀態名稱;不要自行發明工作流程狀態。 - 若指令因驗證/設定失敗,請回報來自
npx -y @starhui/huly-cli@latest context中缺少的已清理欄位;不要暴露機密資訊。僅在使用者確認要使用哪個 dotenv 檔案後,才使用--config <路徑>重試。
實用對應
- 專案:
project list、project get、project statuses、project create、project update、project delete。 - 議題:
issue list、issue get、issue create、issue update、issue delete、issue label、issue unlabel、issue move。 - 全域搜尋:
search。 - 所有上游 MCP 工具:
tools與call。