CLI & REST API

コマンドラインインターフェース(CLI)

Willet CLIは、MCPツールと同じ操作をシェルからスクリプト実行できる形で提供しています。

インストール

CLIはnpmで公開されており、Node.js 20以降が必要です。

npm install -g @willet/cli

インストールされるバイナリは willet. デフォルトでは Willet Cloud に接続します: https://willet.bgenc.dev.

ログイン(Willet Cloud)

インタラクティブな使用には、ブラウザからログインしてください。デバイス認証ページが開き、短期間有効なトークンが ~/.willet/ に保存されます。

willet login

承認されたら、アクティブなIDを確認してください:

willet whoami

保存された認証情報をクリアするには willet logout.

APIシークレットを使用する(スクリプト、CI、セルフホスト)

ブラウザログインをスキップして無人で使用するには、シークレットを WILLET_API_TOKEN.

export WILLET_API_TOKEN=... willet whoami
  • スコープは user(アクセスできるすべてのプロジェクト)または project(単一のプロジェクト)のいずれかです。
  • アクセスレベルは read(読み取り専用)または read_write(フルアクセス)のいずれかです。
  • `WILLET_API_TOKEN` は保存済みのログインより優先され、ディスクには書き込まれません。

セルフホストサーバーをターゲットにする

CLIを自分のWilletサーバーに向ける方法は3つあります(優先度の高い順):

  • --api-url <url> 任意のコマンドのグローバルフラグ
  • WILLET_API_URL 環境変数
  • apiUrl `willet.config.ts` の `apiUrl` フィールド ~/.willet/config.json

セルフホストサーバーはWilletログインに対応していません。サーバーの設定ファイルにあるユーザーシークレットを`WILLET_API_TOKEN`に設定して認証してください。

出力とスクリプト

  • --json 生のJSONを出力します(人が読みやすい形式ではありません)。jq などのツールにパイプして使ってください。
  • -p <projectId> ほとんどのタスクコマンドにはプロジェクトのUUIDが必要です。
  • tagsフラグはカンマ区切りではなく、スペース区切りです: --tags backend perf
willet --json ticket create "Set up CI" -p $PROJECT --type chore --tags ci infra

コマンドリファレンス

コマンドはリソースごとにグループ化されています。各グループには専用のサブコマンドがあります:

グループサブコマンド
willet ticketlist, search, get, create, update, delete, start, complete, cancel, reopen, comment, link, unlink, graph, tags
willet projectlist, create, delete, restore, set-key-prefix, stats, members
willet orglist, create, update, delete, members
willet githublist, link, unlink
willet renderboard, dependency-graph

任意のコマンドの詳細なフラグは以下で確認できます willet <group> --help.

終了コード

スクリプトはプロセスの終了コードで分岐できます:

0成功
1一般エラーまたはネットワークエラー
2認証に失敗しました(401)
3権限エラー(403)。例:書き込みに読み取り専用のシークレットを使用した場合
4見つかりません (404)

次へ

CLIで行えることはすべてREST API経由で実行されています。シェルを使いたくない場合は、APIを直接ご利用ください。

REST APIリファレンス