主なコマンド
TWP CLI のデータ操作コマンドは、twp <機能> <操作> の形をしています(例: twp task list)。ここでは、よく使うプロジェクト・タスクの操作と、そのほかの機能の代表例を紹介します。
すべてのコマンドとオプションは、
twp --helpとtwp <機能> helpで確認できます。 たとえばtwp task helpでタスクの操作一覧が、twp task create helpでタスク作成のオプションが表示されます。ヘルプは常にお使いの版に合った内容を表示するので、このページに無いコマンドはヘルプをご覧ください。
プロジェクト
twp project list # 参加しているプロジェクトの一覧
twp project get SAMPLE # プロジェクト1件の詳細(コードまたは ID で指定)
twp project members SAMPLE # プロジェクトのメンバー以降のコマンドの --project には、一覧の code 列の値(例: SAMPLE)を指定します。
タスク
一覧・詳細を見る
twp task list --project SAMPLE # プロジェクトのタスク一覧
twp task list --project SAMPLE --assignee me # 自分が担当のもの
twp task list --project SAMPLE --status 進行中 # ステータスで絞り込む
twp task get SAMPLE-12 # タスク1件の詳細(キーで指定)
twp task subtasks SAMPLE-12 # サブタスクの一覧--status・--type・--assigneeは、画面に表示される名前で指定できます(--assignee meは自分)- 指定できる名前は
twp task status list --project SAMPLE(ステータス)、twp task type list --project SAMPLE(種別)で確認できます - 一覧は既定で 20 件ずつ表示します。続きがあるときは次のページを表示するコマンドが案内されます。すべて表示するには
--allを付けます
作成・更新・削除する
twp task create --project SAMPLE --subject "見積書のひな形を更新する" --assignee me
twp task update SAMPLE-12 --status 進行中
twp task delete SAMPLE-12 --yes--status/--typeを省略すると、プロジェクトの既定値(例: 「未着手」「タスク」)が使われます- 説明文(本文)は、ファイルに書いて
--description-file <ファイル>で渡すのがおすすめです。改行や見出しがそのまま登録されます - 削除には確認のため
--yesが必要です
コメントする
twp task comment list SAMPLE-12
twp task comment create SAMPLE-12 --body-file comment.mdコメント本文も、ファイルに書いて --body-file で渡します(- を指定すると標準入力から読みます)。
個人タスク
プロジェクトに属さない自分だけのタスク(個人タスク)は、--project __private__ で扱います。
twp task list --project __private__添付ファイル
twp task attachment list SAMPLE-12
twp task attachment upload SAMPLE-12 --file ./資料.pdf
twp task attachment download <添付ID> --out ./資料.pdfそのほかの機能(代表例)
いずれも、TWP の画面でその機能を使える権限が必要です。権限が無い場合は、その旨が表示されて終了します。
| 機能 | 代表的なコマンド | 必要な権限 |
|---|---|---|
| 勤怠 | twp attendance status(いまの打刻状態)twp attendance timesheet --month 2026-09(月の勤怠表)twp attendance punch clock-in(出勤の打刻) | 本人の勤怠のみ。残業・締め状況の参照は勤怠の管理者 |
| 有給 | twp leave list(取得履歴と残日数)twp leave request --date 2026-10-15(有給の申請) | 本人の分のみ |
| ワークフロー(申請) | twp workflow applicable(申請できる申請書)twp workflow instance list(自分の申請)twp workflow approval pending(自分の承認待ち) | 申請・承認は画面と同じ権限 |
| レポート(日報) | twp report list(自分のレポート)twp report create --format <フォーマット名>(下書きの作成。フォーマットは twp report format list で確認) | 本人の分のみ |
| 通知 | twp notification list --unread(未読の通知)twp notification counts(未読件数)twp notification read-all --yes(すべて既読にする) | 本人宛てのみ |
| 販売管理 | twp estimate list(見積一覧)twp invoice list(請求一覧) | 販売管理の権限 |
| 顧客管理 | twp customer list(顧客一覧)twp prospect list(アプローチ先一覧) | 顧客管理の権限 |
| wiki・ノート・議事録 | twp wiki list --project SAMPLE(wiki ページ)twp note list(ノート)twp meeting list(議事録) | 閲覧できる範囲のみ |
各機能の操作とオプションは twp <機能> help をご覧ください(例: twp attendance help)。
送信内容を確認してから実行する
作成・更新・削除などの操作に --dry-run を付けると、実際には送らずに、送る予定の内容を表示します。はじめて使う操作や、まとめて処理するスクリプトを作るときの確認に便利です。
twp task update SAMPLE-12 --status 完了 --dry-run出力の形式を変える
| オプション | 内容 |
|---|---|
--output table | 表形式(ターミナルで実行したときの既定) |
--output json | JSON 形式(パイプやリダイレクトで渡したときの既定)。画面で省略している項目も含めて出します |
--output tsv | タブ区切り(表計算ソフトへの貼り付け向け) |
--output text | 空白区切りのテキスト。wiki・ノート・議事録の詳細(get)では本文を文書として出します |
--query <式> | JSON の中から必要な値だけを取り出す(JMESPath 形式) |
たとえば、進行中のタスクのキーと件名だけを JSON で取り出すには次のようにします。
twp task list --project SAMPLE --status 進行中 --output json --query '[].{key:key,subject:subject}'項目名が token・secret・password・api_key などの値は、どの出力形式でも既定で伏字になります。値そのものが必要な場合だけ、その操作に --no-redact を付けてください(出力は端末の履歴やログに残るため、取り扱いにご注意ください)。
終了コード
twp project / twp task などのデータ操作コマンドは、終了コードで結果を判定できます。
| 終了コード | 意味 |
|---|---|
0 | 成功 |
1 | そのほかの失敗 |
2 | 指定の誤り(オプションの綴り・存在しない名前・日付の形式など) |
3 | サーバーが受け付けなかった(権限が無い・対象が見つからない・入力内容の不備など) |
4 | 通信エラー、サーバー側のエラー、またはアクセスが集中している(しばらく待って再実行してください) |
5 | ログインしていない、またはログインの有効期限切れ(twp login をやり直してください) |
twp login / twp logout / twp whoami は、失敗したときは種類を問わず終了コード 1 を返します。