主なコマンド

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       # プロジェクトのメンバー
twp project mine                 # 自分がメンバーのプロジェクト（役割・参画期間つき）

以降のコマンドの --project には、一覧の code 列の値（例: SAMPLE）を指定します。

メンバーをアサインする

プロジェクトの管理者は、メンバーの追加・役割と稼働期間の変更・削除を行えます。

twp project member create yamada@example.com --project SAMPLE --role member --period-file periods.json
twp project member update yamada@example.com --project SAMPLE --role manager
twp project member update yamada@example.com --project SAMPLE --period-file periods.json --dry-run
twp project member delete yamada@example.com --project SAMPLE --yes

• 稼働期間は JSON ファイル（--period-file）で渡します。例: [{"start_date":"2026-10-01","end_date":"2026-12-31","daily_hours":8,"input_mode":"hours"}]
• update で稼働期間を渡すと、今の期間は渡した内容で丸ごと置き換わります。 消える期間は送信前に表示されるので、--dry-run で確認してから実行してください。残したい期間は twp project members SAMPLE --output json に出る id を付けたまま渡します
• メンバーは氏名・メールアドレス・ID・me（自分）で指定できます。役割（--role）に指定できる値は twp project member create help で確認できます
• 組織管理者は、twp user projects <ユーザー> で指定したユーザーが参画しているプロジェクトを一覧できます

タスク

一覧・詳細を見る

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 <機能> help をご覧ください（例: twp attendance help）。

送信内容を確認してから実行する

作成・更新・削除などの操作に --dry-run を付けると、実際には送らずに、送る予定の内容を表示します。はじめて使う操作や、まとめて処理するスクリプトを作るときの確認に便利です。

twp task update SAMPLE-12 --status 完了 --dry-run

出力の形式を変える

たとえば、進行中のタスクのキーと件名だけを 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 などのデータ操作コマンドは、終了コードで結果を判定できます。

twp login / twp logout / twp whoami は、失敗したときは種類を問わず終了コード 1 を返します。