スクリプトと一覧取得
取得結果をファイルに保存したり、別のプログラムに渡したりする場合は、コマンドが対応するJSONオプションと終了コードを利用してください。
JSON結果を保存する
aipctl skill list --org ORG_SLUG --json > skills.json
aipctl agent list --org ORG_SLUG --json > agents.json
aipctl org list --json > organizations.json--jsonはすべてのコマンドに共通するオプションではありません。先にaipctl COMMAND --helpで対応を確認してください。例えば、config status、auth whoami、chat messagesには付けません。
JSON出力でも秘密情報がマスクされる場合があります。通常のテキスト出力には案内や進行状況が含まれるため、データを処理するスクリプトでは対応するJSON出力を利用してください。
次のページを取得する
組織共有スキルの一覧では、--pageでページを、--page-sizeで1回に取得する件数を指定できます。
aipctl admin skill list --page 1 --page-size 20 --json
aipctl admin skill list --page 2 --page-size 20 --json次のページを取得するときは--pageを1ずつ増やし、組織・検索条件・--page-sizeは同じにしてください。admin skill listにはAI担当者の権限が必要です。
一覧ごとに異なるオプション
| コマンド | 検索・ページのオプション | JSON出力 |
|---|---|---|
skill list | --search | --json |
skill library, skill built-in | --search | 非対応 |
drive list | なし | 非対応 |
chat list | なし | --json |
admin skill list | --search, --page, --page-size | --json |
automation list | --name | --json |
ページ指定に対応しないコマンドには、取得件数や次のページを指定するオプションを付けないでください。必要な項目が見つからない場合は、ウェブでも確認してください。
オプションの大文字・小文字とハイフンは、そのまま入力します。取得中に項目が追加・削除されると、ページ間で重複や欠落が起きる場合があります。重要な全件取得では、結果のIDを確認し、変更が少ない時間帯に実行してください。
失敗を確認する
対応するJSON取得コマンドのAPIエラーは、標準エラー出力(stderr)に出力されます。成功データとエラーを分けて保存できます。
aipctl skill list --json > skills.json 2> skills-error.jsonファイルサイズだけで成功を判断せず、終了コードを確認してください。空の一覧も正常な結果の場合があります。一般的な管理コマンドでは、次の値を参考にできます。
| 終了コード | 意味と次の対応 |
|---|---|
0 | コマンド完了。複数項目を処理した場合は、各項目の結果も確認します。 |
1 | リクエスト・認証などの失敗。エラーコードとメッセージを確認します。 |
2 | 一般配布で提供されないコマンドの実行拒否などに使われます。 |
130 | Ctrl+Cによる中断。サーバー側の完了・キャンセル状態は別途確認します。 |
オプションの入力エラーやMCP接続コマンドが、同じJSONエラー形式を使うとは限りません。
繰り返し実行する場合
--orgで対象組織を明示し、既定の組織変更による誤操作を防ぎます。- 大量のリクエストを一度に送らず、間隔と同時実行数を制限します。
429の場合は案内された時間を待ち、取得頻度を下げます。- 作成・変更・削除が中断した場合は、先に一覧と詳細を確認します。結果が不明なまま同じ変更を繰り返さないでください。
- 実行バージョンの固定方法は、CLIを更新するを参照してください。