コマンドリファレンス
操作ごとのコマンドと、必要な入力・主なオプションを確認できます。
共通の使い方
- 組織の業務コマンドは選択中の組織を使用します。
--org ORG_SLUGで、そのリクエストの組織を指定できます。ログイン・ローカル設定・PCトンネル接続は、それぞれの入力方法に従います。 - IDは一覧の取得結果から確認します。名前・組織のslug・リソースIDは区別して使用してください。
- JSON出力やページ指定は、対応するコマンドだけで利用できます。表にない詳細なオプションは、各コマンドの
--helpで確認してください。 --forceは削除・除外・脱退の実行確認です。権限確認を回避したり、失敗した処理を強制したりするものではありません。-fでも指定できます。adminはCLIの管理コマンドグループです。対象と操作によって必要な権限が異なります。- ヘルプに表示されるコマンドにも、アカウント権限とサーバーの提供条件が適用されます。制限を回避するために開発用配布へ切り替えないでください。
最上位のグループ
| グループ | 用途 |
|---|---|
auth, config | ログインと接続環境 |
org | 組織の選択・情報 |
skill, agent, automation | リソースの確認・管理 |
chat, drive, integration | 会話・ファイル・連携の確認 |
model | モデル一覧の取得 |
admin | org、agent、skill、integration、usage、audit、tunnelの管理グループ |
tunnel | PCトンネル接続 |
admin skill githubにはinspect、import、sync、credentialsがあり、credentialsにはsetとclearがあります。tunnel配下の実行コマンドはlinkです。
ログインと接続設定
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl auth login | なし | ブラウザーでログインして組織を選択します。同じPCで完了してください。 |
aipctl auth logout | なし | ローカルのログイン情報を削除します。送信済みの処理は取り消しません。 |
aipctl auth status | なし | 保存済みのログイン状態と有効期限を確認します。サーバー接続の成功確認ではありません。 |
aipctl auth whoami | なし | 現在のユーザー情報をサーバーから取得します。 |
aipctl auth refresh | なし | 認証トークンを更新します。更新できないセッションでは再ログインしてください。 |
aipctl config set | --app-url APP_URL | 接続先URLを保存します。変更時はログインと組織選択が初期化されます。 |
aipctl config status | なし | PCに保存された接続先URLと設定を確認します。 |
組織
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl org list | [--json] | アクセスできる組織とslugを取得します。 |
aipctl org current | なし | 保存済みの既定の組織を確認します。 |
aipctl org use | ORG_SLUG | 以降のコマンドで使う既定の組織を保存します。 |
aipctl org select | なし | ブラウザーで既定の組織を選択します。 |
aipctl org members | [--org ORG_SLUG] | 組織メンバーを取得します。AI担当者の権限が必要です。 |
aipctl org capabilities | [--org ORG_SLUG] | 組織で利用できる機能を取得します。 |
aipctl org settings | なし | 現在のユーザー設定を取得します。組織設定の変更ではありません。 |
aipctl org exit | --force [--org ORG_SLUG] | 指定した組織から脱退します。先に対象組織を確認してください。 |
スキル
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl skill list | [--search TEXT] [--json] | アクセスできるスキルの一覧を取得します。 |
aipctl skill get | SKILL_ID [--json] | 詳細と最大10件のファイル情報を取得します。 |
aipctl skill upload | FILE [--overwrite] | .zip・.skillを登録します。同名の置換時だけ--overwriteを使用してください。 |
aipctl skill download | SKILL_ID [-o FILE] | ダウンロード可能な組織スキルを保存します。同じ保存先のファイルは上書きされます。 |
aipctl skill delete | SKILL_ID --force | 対象を確認してから削除します。 |
aipctl skill library | [--search TEXT] | 共有ライブラリの一覧です。--jsonには非対応です。 |
aipctl skill clone | SKILL_ID [SKILL_ID ...] | ライブラリから最大5件を複製します。各結果を確認してください。 |
aipctl skill built-in | [--search TEXT] | ビルトインスキルを取得します。AI担当者の権限が必要です。 |
aipctl skill clone-built-in | SKILL_ID [SKILL_ID ...] | ビルトインスキルを最大5件複製します。AI担当者の権限が必要です。 |
エージェント
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl agent list | [--json] | インストール済みのエージェント一覧を取得します。 |
aipctl agent get | AGENT_ID [--json] | 名前・説明・必要な連携を取得します。 |
aipctl agent enable | AGENT_ID | ポリシーと権限に従って有効化します。 |
aipctl agent disable | AGENT_ID | エージェントを無効化します。 |
aipctl agent chat | --agentId AGENT_ID -m MESSAGE [--json]または--conversation-id ID -m MESSAGE [--json] | 会話を開始・継続します。標準入力にも対応します。結果が不明な場合は、再送前に会話履歴を確認してください。 |
自動化
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl automation list | [--name TEXT] [--json] | 名前で絞り込むか、JSONで取得します。先頭50件で、次のページの指定はできません。 |
aipctl automation get | AUTOMATION_ID [--json] | 保存済みの詳細を取得します。秘密情報は全文表示されない場合があります。 |
aipctl automation triggers | webhook --service-type SERVICE_TYPE | Webhook設定情報を取得します。外部メール・ストレージの設定情報取得は制限されています。 |
aipctl automation history | AUTOMATION_ID [--page N] | 実行履歴をページごとに取得します。 |
aipctl automation create | JSON_FILE | スケジュール・Webhook・マイドライブの自動化を作成します。JSONのトリガー種類を合わせてください。 |
aipctl automation update | AUTOMATION_ID JSON_FILE | 対応する自動化を変更します。維持するフィールドも入力ファイルに含めてください。 |
aipctl automation delete | AUTOMATION_ID --force | 自動化を削除します。 |
aipctl automation enable | AUTOMATION_ID | 自動化を有効化します。条件に応じてエージェントが実行されます。 |
aipctl automation disable | AUTOMATION_ID | 自動化を無効化します。実行中の処理のキャンセル完了を意味しません。 |
aipctl automation run | AUTOMATION_ID | 即時実行を要求します。完了は実行履歴で確認してください。 |
aipctl automation cancel | AUTOMATION_ID SEQ | 履歴の実行番号でキャンセルを要求します。実行状態と最終結果を確認してください。 |
aipctl automation webhook-regen | AUTOMATION_ID [--show-sensitive] | Webhook URLを再発行します。既定の出力はマスクされます。外部送信元の接続先も確認してください。 |
automation triggersのヘルプにある--account-id・--folder-idは、外部サービス用のオプションです。入力できても、現在のサーバーがそのサービスに対応しているとは限りません。設定情報の取得とサービスの種類を確認してください。
会話とマイドライブ
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl chat list | [--json] | 自分の会話一覧を取得します。 |
aipctl chat get | CONVERSATION_ID | 自分の会話の詳細です。--jsonはありません。ウェブ上の添付・タグ・アーカイブ状態のすべては再現しません。 |
aipctl chat messages | CONVERSATION_ID | マスク済みのテキストを1件最大500文字表示します。--jsonはありません。 |
aipctl drive list | なし | マイドライブの項目を取得します。--jsonはありません。 |
aipctl drive mkdir | NAME | ルートにフォルダーを作成します。親フォルダーの指定はできません。 |
aipctl drive rename | ENTRY_ID NEW_NAME | ファイル・フォルダー名を変更します。 |
aipctl drive delete | ENTRY_ID [ENTRY_ID ...] --force | 1件または複数のファイル・フォルダーを削除します。フォルダーは配下にも影響します。 |
aipctl drive usage | なし | ストレージ使用量を取得します。 |
aipctl drive upload | FILE | ローカルファイルをルートへアップロードします。出力IDと一覧で完了を確認してください。 |
aipctl drive download | ENTRY_ID --output FILE | 保存先は必須です。-oも使用でき、同じパスは上書きされます。 |
連携とモデル
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl integration list | なし | アクセスできる連携とポリシーの状態を取得します。 |
aipctl integration test | INTEGRATION_ID | 接続テストを要求します。非対応の連携では拒否される場合があります。 |
aipctl model list | なし | モデルID一覧を取得します。 |
組織メンバーの管理
組織管理権限と組織ポリシーが適用されます。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl admin org invite | EMAIL [EMAIL ...] [--role ROLE] | 最大100件を招待します。既定の役割はmemberで、一部が失敗する場合があります。 |
aipctl admin org remove-member | EMAIL [EMAIL ...] --force | 最新の状態を確認してから組織から削除します。 |
aipctl admin org update-member-role | EMAIL [EMAIL ...] --role ROLE | 役割を変更します。owner、admin、aiOperator、memberを指定できます。 |
組織エージェントの管理
AI担当者の権限とエージェント管理ポリシーが適用されます。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl admin agent create | JSON_FILE | JSON設定から作成します。必要な設定と有効化は別途確認してください。 |
aipctl admin agent update | AGENT_ID JSON_FILE | エージェントの種類に合うJSONで更新します。 |
aipctl admin agent delete | AGENT_ID --force | 関連する処理を確認してから削除します。 |
aipctl admin agent share | AGENT_ID | 共有設定を取得します。共有先の変更ではありません。 |
aipctl admin agent templates | なし | テンプレート一覧を取得します。 |
aipctl admin agent export | AGENT_ID [--output FILE] | YAMLで保存します。-oも使用でき、省略時はAGENT_ID.yamlに保存します。 |
組織スキルの管理
組織共有スキル · GitHubからの取り込み · PATの管理
AI担当者の権限が必要です。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl admin skill list | [--search TEXT] [--page N] [--page-size N] [--json] | 組織スキルをページごとに取得します。 |
aipctl admin skill get | SKILL_ID [--json] | 詳細とGitHub接続情報を確認します。 |
aipctl admin skill upload | FILE [--overwrite] | 組織スキルのファイルを登録します。同名の置換か確認してください。 |
aipctl admin skill download | SKILL_ID [-o FILE] | 組織スキルをダウンロードします。同じ保存先は上書きされます。 |
aipctl admin skill delete | SKILL_ID --force | 組織スキルを削除します。 |
aipctl admin skill publish | SKILL_ID | ライブラリに公開します。 |
aipctl admin skill unpublish | SKILL_ID | ライブラリへの公開を解除します。 |
aipctl admin skill built-in | [--search TEXT] | ビルトインスキル一覧を取得します。 |
aipctl admin skill clone-built-in | SKILL_ID [SKILL_ID ...] | 最大5件のビルトインスキルを複製します。各結果を確認してください。 |
aipctl admin skill github inspect | GITHUB_URL [--pat-env ENV_NAME] [--json] | リポジトリ・ブランチ情報を確認します。 |
aipctl admin skill github import | GITHUB_URL [--pat-env ENV_NAME] [--overwrite] [--json] | リポジトリまたはスキルフォルダーから組織スキルを取り込みます。 |
aipctl admin skill github sync | SKILL_ID [--apply] [--json] | 既定では変更確認だけを行い、--applyで更新します。 |
aipctl admin skill github credentials set | SKILL_ID --pat-env ENV_NAME | スキル用のGitHub PATを保存・変更します。環境変数名を指定してください。 |
aipctl admin skill github credentials clear | SKILL_ID | 保存したPATを削除します。GitHub上のトークンは失効しません。 |
連携の管理
AI担当者の権限が必要です。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl admin integration available | なし | 利用できる連携一覧を取得します。 |
aipctl admin integration get | INTEGRATION_ID | 詳細な設定状態を確認します。 |
aipctl admin integration tools | INTEGRATION_ID | ツール名・説明・ポリシー状態を確認します。実行は行いません。 |
aipctl admin integration update | INTEGRATION_ID JSON_FILE | 連携ごとの入力形式に合うJSONで変更します。取得結果をそのまま使わないでください。 |
aipctl admin integration delete | INTEGRATION_ID --force | 利用中のエージェント・プリセットを確認してから削除します。 |
使用量と監査ログ
使用量には組織管理者権限、監査ログには対応プランとアクセス権限が必要です。使用量の既定期間は今月1日から今日までで、日付はYYYY-MM-DD形式で指定します。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl admin usage credit | [--start DATE] [--end DATE] | 期間内のクレジット使用量とユーザー統計を取得します。 |
aipctl admin usage top-users | [--start DATE] [--end DATE] [--limit N] | ユーザー別の使用量順位です。既定は上位10件です。 |
aipctl admin usage daily-graph | [--start DATE] [--end DATE] | 日別の使用量を取得します。 |
aipctl admin usage daily-users | [--start DATE] [--end DATE] [--page N] [--user-id USER_ID] | 日別ユーザー統計を取得し、ユーザーで絞り込めます。 |
aipctl admin usage mcp-top | [--start DATE] [--end DATE] [--limit N] | MCPツールの使用量順位です。既定は上位10件です。 |
aipctl admin audit list | [--type EVENT_TYPE] [--page N] | イベント種類とページを指定して取得します。 |
aipctl admin audit types | なし | 監査イベント種類の識別子を取得します。 |
PCトンネル接続
接続トークンはウェブのPC接続案内で準備します。一般管理用のログインとは別です。
| コマンド | 入力・主なオプション | 動作と注意点 |
|---|---|---|
aipctl tunnel link | CONNECTION_TOKEN | PCトンネルを接続します。作業中はプロセスを維持し、Ctrl+Cで終了します。 |
aipctl admin tunnel status | [--org ORG_SLUG] | 組織内の自分の接続状態を取得します。組織全体の接続一覧ではありません。 |
aipctl admin tunnel config | [--show-sensitive] [--org ORG_SLUG] | 接続コマンドと接続数を取得します。秘密情報は既定でマスクされます。 |
aipctl admin tunnel token | [--org ORG_SLUG] | 接続トークンの作成を要求します。成功出力にトークン自体は表示しません。 |
出力と失敗時の対応
- スクリプトと一覧取得:JSON対応、ページ指定、終了コード
- 制限事項とトラブルシューティング:認証・権限・上限・取得制限・変更結果が不明な場合の対応
必要な入力を確認するには、コマンドの末尾に--helpを付けてください。ヘルプは操作を実行しません。
Last updated on