CLI 參考

用 Agent 的方式
探索指令。

TWG 內建為人類與機器同時設計的 help 系統，
每個指令都附 JSON 介面。

快速上手

三步驟跑出你的第一個查詢。

安裝

curl -fsSL https://twg.dev/install | sh

探索

twg help

為 Agent 而設計

能自我描述的指令。

三個探索原語，讓任何 Agent 不需先備知識也能逛遍整個 CLI。

twg help

頂層指令地圖。

回傳精簡 YAML，列出每個 namespace 及其可執行的子指令。用 $ 來辨識 namespace 裡的葉節點指令。

tree:
  $: [resolve, search, login, logout, help]
  jira:
    board: {}
    sprint: {}
    workitem: {}
  confluence:
    page: {}
    blog: {}
    space: {}
  ...

twg help <terms>

模糊指令搜尋。

傳入任何關鍵字，TWG 會依相關性排序指令；適合只記得片段的情況。

$ twg help sprint
matches:
  - twg jira sprint
  - twg jira sprint workitems
  - twg confluence search --label sprint

twg help describe <path>

指令的完整 JSON 介面。

回傳精確的 arg/option/output schema，包含 recommendedAgentFields、output preset 與風險提示。

{
  "type": "cmd",
  "id": "twg:search",
  "cmd": "twg search",
  "args": [{"name": "query", "req": true}],
  "opts": [
    {"long": "--limit", "arg": "<n>"},
    {"long": "--app", "arg": "<app>"},
    ...
  ],
  "output": {
    "recommendedAgentFields": "@compact",
    "primaryCollection": "items"
  }
}

指令樹

完整介面，井然有序。

以下是 CLI 的即時樣貌。每個葉節點都有 JSON 介面——透過 twg help describe 取得。

core

resolve, search, login, logout, doctor, setup, help, update

jira

board, field, sprint, workitem, space

confluence

page, blog, database, folder, labels, space, search, task, whiteboard, comment

bitbucket

repo, branch, commit, pull-requests, pipeline, deployment, search, workspace

jsm

incident, alert, automation, conversation, portal, request-type, knowledge-article, knowledge-base, post-incident-review

assets

object, objectschema, type, service-object, object-attribute-value, objects

trello

board, card, list, workspace, member, search

loom

video, space, workspace, invite, settings

goals

create, get, query, update, archive, link, unlink, status-update

projects

create, get, query, update, archive, status-update

focus-areas

get, query, search

rovo

search, list-apps

context

user, jira workitem, confluence page, confluence blogpost, confluence space, confluence whiteboard

visualize

html, gexf

csm

channel, context, organization

talent

position

給 Agent 的輸出

三個能讓 token window 保持乾淨的開關。

格式

--output json | yaml | compact

三種格式，分別針對不同場景調校。

精簡檢視

output_files.compact

預先摘要的列資料，讓 Agent 讀到的是證據、不是噪音。

預設欄位

--agent-fields @compact or @evidence

為每個指令精選的欄位組合，直接套用。

精簡的 Agent 友善搜尋

$ twg search "incident review" --limit 20 \
    --output json \
    --output-summary auto \
    --agent-fields @compact \
    | jq '.items[] | {title, url, app}'

接上你的 Agent 棧

任何 Agent 框架都能直接接上。

Claude Code

用 twg skills install 把 TWG 的 380+ 指令包成 skills 並注入 Claude Code——Anthropic 官方 CLI agent 會自動發現這些 skills 並能直接呼叫。同一個指令也能一次裝給 Cursor、Codex、Gemini、Copilot 等其他 coding agent。

Terminal · 一行指令

# 安裝 TWG skills 給 Claude Code
twg skills install --agent claude

# 或一次裝給所有支援的 coding agent
twg skills install --all-agents

CrewAI

把 TWG 包成 @tool，CrewAI agent 就能用自然語言呼叫任意 twg 指令並取得結構化 JSON。

crew_tools.py

from crewai.tools import tool
import subprocess, json

@tool("twg")
def twg(cmd: str) -> dict:
    out = subprocess.check_output(
        ["twg", *cmd.split(), "-o", "json"]
    )
    return json.loads(out)

LangGraph

在 LangGraph 中把 twg_run 包進 ToolNode，讓關係連結圖的每個節點都能查 Atlassian 工作資料。

agent.py

from langgraph.prebuilt import ToolNode
from langchain_core.tools import tool
import subprocess, json

@tool
def twg_run(args: list[str]) -> dict:
    """Run a twg CLI command and return parsed JSON."""
    raw = subprocess.check_output(["twg", *args, "-o", "json"])
    return json.loads(raw)

tools = ToolNode([twg_run])

用 Agent 的方式探索指令。