AgentBay:AgentBay CLI

主な機能

• 認証管理：安全な OAuth ベースのサインインメカニズムを使用して、Alibaba Cloud アカウントと連携します。

• イメージ管理：カスタムイメージを参照、作成、有効化、無効化、削除し、イメージのステータスを表示します。

• イメージ作成：クラウド ベースとローカルの両方のビルドモードをサポートします。

• イメージの有効化：カスタムリソース、ネットワーク構成、ライフサイクル管理を使用して、カスタムイメージインスタンスを有効化します。

• イメージの無効化：リソースを解放するために、アクティブなイメージインスタンスを無効化します。

• テンプレートのダウンロード：クラウドから Dockerfile テンプレートをダウンロードします。

• APIキー管理：API キーを作成し、同時実行数の制限を設定します。

• スキル管理：ローカルのスキルをクラウドにプッシュし、ID で詳細を表示します。

• 構成管理：トークンを安全に保存し、自動的に更新します。

• ネットワーク管理：作成済みのネットワークパッケージを一覧表示します。

• イメージステータス：イメージのビルドステータスとリソースステータスを表示します。

サポートされるイメージタイプ

現在、CLI ツールは CodeSpace カスタムイメージの作成と有効化のみをサポートしています。image list の出力にある TYPE 列には、DockerBuilder や DedicatedDesktop などの基盤となるカテゴリが表示されますが、これは CLI 操作とは無関係です。

tap によるインストール (推奨)

# 1. AgentBay Cloud Homebrew Tap を追加
brew tap aliyun/agentbay

# 2. agentbay コマンドラインツールをインストール
brew install agentbay

# 3. インストールを確認
agentbay version
            

# バージョン情報を確認
agentbay version

# ヘルプを表示
agentbay --help

# agentbay のコマンドを実行
agentbay [command] [options]
            

# 方法 1：agentbay のみをアップグレード
brew upgrade agentbay

# 方法 2：方法 1 が失敗した場合に試してください
git -C $(brew --repository aliyun/agentbay) pull && brew upgrade agentbay

# 方法 3：最初の 2 つの方法が失敗した場合に試してください
brew update
brew reinstall agentbay
            

# agentbay をアンインストール
brew uninstall agentbay

# Tap を削除 (オプション)
brew untap aliyun/agentbay
            

# Homebrew を更新
brew update

# キャッシュをクリーンアップ
brew cleanup

# 再インストール
brew reinstall agentbay
              

# Go プロキシを設定
export GOPROXY=https://goproxy.cn,direct
export GOSUMDB=sum.golang.google.cn

# 再インストール
brew reinstall agentbay
              

# Homebrew の権限を修正
sudo chown -R $(whoami) $(brew --prefix)/*
              

手動インストール

GitHub Releases から、お使いのプラットフォーム向けの最新バージョンをダウンロードします。

ステップ 1：ログイン

AgentBay にログインします。CLI は Alibaba Cloud の認証のためにブラウザーを開き、ログイン後にターミナルに戻ります。

agentbay login

ステップ 2：利用可能なイメージの表示

# カスタムイメージのみを一覧表示 (デフォルト)
agentbay image list

# システムイメージとカスタムイメージを含める
agentbay image list --include-system

# システムイメージのみを表示
agentbay image list --system-only

ステップ 3：Dockerfile テンプレートのダウンロード

Dockerfile テンプレートをカレントディレクトリにダウンロードします。ソースイメージ ID を指定する必要があります。利用可能なシステムイメージ ID は、agentbay image list --system-only を実行して確認できます：

agentbay image init --sourceImageId code-space-debian-12

ステップ 4：カスタムイメージの作成

agentbay image create myapp --dockerfile Dockerfile --imageId code-space-debian-12

ステップ 5：イメージのアクティベート

カスタムイメージは、デプロイする前にアクティベートする必要があります。システムイメージはアクティベート不要です。

agentbay image activate imgc-xxxxx...xxx

ステップ 6：イメージのディアクティベート

リソースを節約するため、不要になったカスタムイメージはディアクティベートします。この操作により、イメージに割り当てられているリソースが解放されます。

agentbay image deactivate imgc-xxxxx...xxx

ステップ 7：API キーの作成

agentbay apikey create --name "my-api-key"

ステップ 8：セッションの同時実行数の設定

agentbay apikey concurrency set --api-key-id ak-xxx --concurrency 10

グローバルオプション

すべてのコマンドは、次のグローバルオプションをサポートしています：

• --help, -h：コマンドのヘルプ情報を表示します。

• --verbose, -v：詳細な出力を有効にして、デバッグ情報を表示します。

• --version：CLI バージョン情報を表示します。

コマンド構造

agentbay [global options] <command> [command options] [arguments]

コマンド一覧

次の表に、AgentBay CLI コマンドを機能別に示します。

イメージのアクティベーションとディアクティベート

• カスタムイメージ：デプロイメントに使用する前にアクティベートする必要があります。

• システムイメージ：常に利用可能であり、アクティベートする必要はありません。

• イメージのディアクティベート：カスタムイメージが不要になった場合、関連するコンピューティングリソースをリリースするためにディアクティベートします。

イメージ一覧

利用可能な AgentBay イメージを一覧表示します。

構文

agentbay image list [options]

オプション

• --os-type, -o <type>：オペレーティングシステムのタイプ (Linux、Android、または Windows) でフィルタリングします。

• --include-system：カスタムイメージとシステムイメージの両方を表示します。

• --system-only：システムイメージのみを表示します。

• --page, -p <number>：ページ番号 (デフォルト: 1)。

• --size, -s <number>：1 ページあたりに表示する項目数 (デフォルト: 10)。

例

# カスタムイメージを一覧表示
agentbay image list

# Linux イメージを一覧表示
agentbay image list --os-type Linux

# すべてのイメージを一覧表示 (カスタム + システム)
agentbay image list --include-system

# システムイメージのみを一覧表示
agentbay image list --system-only

# ページネーションを使用してクエリ
agentbay image list --page 2 --size 5

出力の説明

コマンドの出力には、次の列が含まれます。

• Image ID：イメージの一意の識別子。

• Image name：イメージの名前。

• Type：イメージのタイプ (DockerBuilder または DedicatedDesktop)。

• Status：イメージのステータス。

• OS：オペレーティングシステムのタイプとバージョン。

• Use case：イメージのユースケース。

ステータスの説明

• Creating：イメージのビルド中です。

• Available：イメージのビルドが完了し、アクティベートできる状態です。

• 起動済み: イメージが起動され、実行中です。

• Create Failed：イメージのビルドに失敗しました。

イメージ初期化

指定したベースイメージの Dockerfile テンプレートを現在のディレクトリにダウンロードします。

構文

agentbay image init --sourceImageId <image-id>

例

# Dockerfile テンプレートをダウンロード
agentbay image init --sourceImageId code-space-debian-12

出力例

[INIT] Downloading Dockerfile template...
Requesting Dockerfile template... Done.
Downloading Dockerfile from OSS... Done.
Writing Dockerfile to /path/to/current/directory/Dockerfile...
[WARN] Dockerfile already exists at /path/to/current/directory/Dockerfile
[INFO] The existing file will be overwritten.
 Done.
[SUCCESS] Dockerfile template downloaded successfully!
[INFO] Dockerfile saved to: /path/to/current/directory/Dockerfile
[IMPORTANT] The first 5 line(s) of the Dockerfile are system-defined and cannot be modified.
[IMPORTANT] Please only modify content after line 5.

イメージ作成

Dockerfile から新しい AgentBay イメージを作成します。

構文

agentbay image create <image-name> --dockerfile <path> --imageId <base-image-id>

引数

• <image-name>：カスタムイメージの名前。必須です。

オプション

• --dockerfile, -f <path>：Dockerfile へのパス。必須です。

• --imageId, -i <id>：ベースイメージの ID。必須です。

例

# 完全なオプション名を使用
agentbay image create my-app --dockerfile ./Dockerfile --imageId code-space-debian-12

# 短いオプション名を使用
agentbay image create my-app -f ./Dockerfile -i code-space-debian-12

# 詳細な出力モードを使用
agentbay image create my-app -f ./Dockerfile -i code-space-debian-12 -v

出力例

[BUILD] Creating image 'my-app'...
[STEP 1/4] Getting upload credentials... Done.
[STEP 2/4] Uploading Dockerfile... Done.
[STEP 3/4] Uploading ADD/COPY files (N files)... Done.
[STEP 4/4] Creating Docker image task... Done.
[STEP 5/5] Building image (Task ID: task-xxxxx)...
[STATUS] Build status: RUNNING
[SUCCESS] Image created successfully!
[RESULT] Image ID: imgc-xxxxx...xxx

ビルドプロセス

1. アップロード認証情報を取得します。

2. Dockerfile をオブジェクトストレージにアップロードします。

3. Dockerfile に ADD/COPY 命令がある場合、参照されているファイルをアップロードします。

4. Docker イメージビルドタスクを作成します。

5. イメージのビルドを開始します。

ADD/COPY ファイルのアップロード

イメージを作成する際、CLI は Dockerfile 内の COPY および ADD 命令を解析し、参照されているローカルファイルを自動的にアップロードします。パスは Dockerfile を含むディレクトリからの相対パスです。この機能は、単一ファイル、複数ファイル、サブディレクトリ、および *.py などのワイルドカードをサポートします。絶対パス、../ などのパストラバーサル、および ADD 命令の URL ソースはサポートされていません。COPY または ADD で参照されるすべてのファイルが、Dockerfile ディレクトリまたはそのサブディレクトリに存在することを確認してください。

イメージのアクティベーション

カスタムイメージをアクティベートし、デプロイメントに使用できるようにします。

構文

agentbay image activate <image-id> [options]

引数

• <image-id>：アクティベートするイメージの ID。必須です。

オプション

• --cpu, -c <cores>：CPU コア数 (2、4、8、または 16)。

• --memory, -m <GB>：メモリ容量 (GB 単位) (4、8、16、または 32)。

• --network-type：ネットワークタイプを指定します。高度なネットワークには ADVANCED、基本ネットワークには DEFAULT を使用します。指定しない場合、デフォルトは基本ネットワークです。

• --session-bandwidth：セッションごとの最大パブリック帯域幅を Mbps 単位で設定します。値は 2 から 200 の間でなければなりません。このオプションは高度なネットワークにのみ適用されます。指定しない場合、帯域幅は無制限です。

• --dns-address：DNS サーバーの IP アドレス。このオプションは高度なネットワークでのみ使用でき、オプションです。複数の DNS サーバーを構成するには、このオプションを複数回指定できます。

• --lifecycle-mode：サンドボックスライフサイクルのリリースモードを設定します。auto モードでは、ライフサイクルポリシーに基づいてコンピューティングリソースが自動的にリリースされます。manual モードでは、リソースをリリースするためにイメージをディアクティベートする必要があります。

• --lifecycle-max-runtime：最大ランタイム (分単位)。--lifecycle-mode を auto に設定する必要があります。

• --lifecycle-hibernate：最大休止状態期間 (時間単位)。--lifecycle-mode を auto に設定する必要があります。

• --lifecycle-idle-timeout：最大アイドル期間 (分単位)。--lifecycle-mode を auto に設定する必要があります。

サポートされているリソース構成

• 2c4g：2 CPU コア、4 GB メモリ (指定しない場合のデフォルト構成)。

• 4c8g：4 CPU コア、8 GB メモリ。

• 8c16g：8 CPU コア、16 GB メモリ。

• 16c32g：16 CPU コア、32 GB メモリ。

例

# デフォルトのリソース構成 (2c4g) でアクティベート
agentbay image activate imgc-xxxxx...xxx

# 2c4g 構成でアクティベート
agentbay image activate imgc-xxxxx...xxx --cpu 2 --memory 4

# 4c8g 構成でアクティベート
agentbay image activate imgc-xxxxx...xxx --cpu 4 --memory 8

# 8c16g 構成でアクティベート
agentbay image activate imgc-xxxxx...xxx --cpu 8 --memory 16

# 16c32g 構成でアクティベート
agentbay image activate imgc-xxxxx...xxx --cpu 16 --memory 32

# 詳細な出力を使用
agentbay image activate imgc-xxxxx...xxx --cpu 4 --memory 8 -v

# 高度なネットワーク - 最小形式
agentbay image activate imgc-xxxx --network-type ADVANCED

# 高度なネットワーク - 帯域幅構成あり
agentbay image activate imgc-xxxx --network-type ADVANCED --session-bandwidth 10

# 高度なネットワーク - DNS 構成あり
agentbay image activate imgc-xxxx \
  --network-type ADVANCED \
  --dns-address 8.8.8.8 \
  --dns-address 8.8.4.4

# 高度なネットワーク - 完全な構成
agentbay image activate imgc-xxxx \
  --cpu 8 \
  --memory 16 \
  --network-type ADVANCED \
  --session-bandwidth 10 \
  --dns-address 8.8.8.8 \
  --dns-address 114.114.114.114

# サンドボックスライフサイクル - 手動リリース
agentbay image activate imgc-xxxx --lifecycle-mode manual

# サンドボックスライフサイクル - 最大ランタイムによる自動リリース
agentbay image activate imgc-xxx --lifecycle-mode auto --lifecycle-max-runtime 30

# サンドボックスライフサイクル - 完全な構成
agentbay image activate imgc-xxxx \
  --lifecycle-mode auto \
  --lifecycle-max-runtime 50 \
  --lifecycle-hibernate 40 \
  --lifecycle-idle-timeout 30

出力例

[ACTIVATE] Activating image...
Checking current image status... Done.
Creating resource group... Done.
Waiting for activation to complete...
  Status: Activating (elapsed: 5s, attempt: 2/60)
  Status: Activating (elapsed: 13s, attempt: 3/60)
[SUCCESS] Image activated successfully!

使用上の注意

• カスタムイメージのみをアクティベートできます。

• システムイメージは常に利用可能であり、アクティベートする必要はありません。

• --cpu および --memory オプションは一緒に指定する必要があり、サポートされている構成と一致する必要があります。

• CPU とメモリのオプションを省略すると、デフォルト構成 (2c4g) が使用されます。

• アクティベーションプロセスには通常 1 ~ 2 分かかります。

• イメージが既にアクティベートされている場合、コマンドはアクションが不要であることを通知します。

• アクティベーション中、コマンドはイメージのステータスをポーリングします。ポーリング間隔は動的に調整され、最初は短く、時間とともに長くなります。試行回数は最大 60 回で、合計タイムアウトは 30 分です。

イメージのディアクティベート

アクティブなカスタムイメージをディアクティベートし、関連するリソースをリリースします。

構文

agentbay image deactivate <image-id>

引数

• <image-id>：ディアクティベートするイメージの ID。必須です。

例

# イメージをディアクティベート
agentbay image deactivate imgc-xxxxx...xxx

# 詳細な出力を使用
agentbay image deactivate imgc-xxxxx...xxx -v

出力例

[DEACTIVATE] Deactivating image...
Deleting resource group... Done.
Waiting for deactivation to complete...
  Status: Deactivating (elapsed: 5s, attempt: 2/40)
[SUCCESS] Image deactivated successfully!

使用上の注意

• ディアクティベートプロセスには通常 1 ~ 2 分かかります。このプロセス中、コマンドはイメージステータスを最大 40 回ポーリングし、合計タイムアウトは約 20 分です。

• ディアクティベートが完了したら、agentbay image list を実行して、リソースがリリースされたことを確認できます。

• イメージをディアクティベートすると、関連するコンピューティングリソースがリリースされ、課金が停止します。

イメージ削除

カスタムイメージを完全に削除します。この操作は元に戻せません。

前提条件

イメージを削除する前に、コンピューティングリソースをリリースするためにイメージをディアクティベートする必要があります。これを行うには、agentbay image deactivate <image-id> を実行します。

構文

agentbay image delete <image-id>

引数

• <image-id>：削除するイメージの ID。必須です。

例

# 1. まず、イメージをディアクティベート (前提条件)
agentbay image deactivate imgc-xxxxxxxxxxxxxx

# 2. 対話的に削除 (y/N の確認メッセージが表示されます)
agentbay image delete imgc-xxxxxxxxxxxxxx

# 3. スクリプトまたは CI 環境で確認をスキップ
agentbay image delete imgc-xxxxxxxxxxxxxx --yes

# 4. 削除を確認 (イメージが一覧に表示されなくなる)
agentbay image list

出力例

[DELETE] Deleting image 'imgc-0ab5ta4nzbwu9bvaa'...
Checking current image status... Done.
[INFO] GetMcpImageInfo Request ID: 3DFFDC7F-9EC2-10BA-878B-EE1E54D00245
[INFO] Image Type: User
[INFO] Current Status: Available (Deactivated)
Are you sure you want to permanently delete image 'imgc-0ab5ta4nzbwu9bvaa'? This action is irreversible. [y/N]: y
Deleting image... Done.
[INFO] DeleteMcpImage Request ID: 2EB74FE6-5757-167F-B71E-0C474ED0419B
[SUCCESS] Image 'imgc-0ab5ta4nzbwu9bvaa' has been permanently deleted.

イメージステータス

特定のイメージの詳細なビルドステータスとリソースステータスを表示します。

agentbay image status <image-id>

引数

• <image-id>：ステータスを表示するイメージの ID。必須です。

例

agentbay image status imgc-xxxxx...xxx

ステータスの説明

イメージステータスは、ビルドステータスとリソースステータスの 2 つのカテゴリに分かれています。

network package list - ネットワークパッケージの一覧表示

構文

agentbay network package list [options]

オプション

• --biz-region-id <region-id>：リージョン ID (デフォルト：cn-hangzhou)。

例

# デフォルトのChina (Hangzhou) リージョンにあるネットワークパッケージを一覧表示します
agentbay network package list

# 別のリージョンにあるネットワークパッケージをクエリします
agentbay network package list --biz-region-id cn-shanghai

出力

出力には以下の列が含まれます。

• Network package ID：ネットワークパッケージの一意の識別子。

• Office site ID：関連するオフィスサイトの ID。

• EIP addresses：バインドされた Elastic IP アドレス (EIP)。

注意事項

apikey create

構文

agentbay apikey create --name <name>

オプション

• --name <name>：API キーの名前 (必須)。

例

agentbay apikey create --name "my-api-key"

出力例

API Key created successfully.
  ID:      ak-xxxxxxxxxxxx
  Name:    my-api-key
  Created: 2025-01-15 10:30:00

確認

作成後、agentbay apikey list を実行すると、API キーのリストが表示されます。

apikey concurrency set

構文

agentbay apikey concurrency set --api-key-id <api-key-id> --concurrency <number>

オプション

• --api-key-id <api-key-id>：API キーの ID (必須)。

• --concurrency <number>：同時実行数制限。1 以上の値を指定する必要があります (必須)。

例

agentbay apikey concurrency set --api-key-id ak-xxxxx --concurrency 5

確認

API キーの詳細を表示して、新しい同時実行数制限を確認します。

skills - スキルコマンドグループ

構文

agentbay skills <subcommand> [parameters] [options]

サブコマンド

• push：ローカルのスキル (ディレクトリまたは .zip ファイル) をクラウドにプッシュします。

• show：指定されたスキルの詳細を表示します。

グローバルオプション (サブコマンド共通)

• --verbose, -v：詳細出力を有効にし、アップロード URL、アップロードサイズ、RequestId などのデバッグ情報を表示します。

• --help：ヘルプ情報を表示します。

skills push - スキルのプッシュ

このコマンドは、まずアップロード認証情報を取得し、zip ファイルをアップロードしてから、サーバーを呼び出してスキルを作成します。パラメータには、SKILL.md ファイルを含むスキルのルートディレクトリ、または事前にパッケージ化された .zip ファイルのいずれかを指定できます。

構文

agentbay skills push <skill-dir>|<skill.zip>

パラメータ

• <skill-dir>：スキルのルートディレクトリへのパス。ディレクトリには SKILL.md ファイルが含まれている必要があります。CLI はこのファイル内の必須メタデータを検証し、ディレクトリ全体を zip ファイルにパッケージ化してアップロードします。

• <skill.zip>：zip ファイルへのパス。ファイルはそのままアップロードされます。

SKILL.md の要件 (ディレクトリモード)

• スキル名を指定する name: 行を含める必要があります (必須)。例： name: my-skill。

• description: 行を含めて、スキルの説明を提供することもできます。

• YAML 形式のフロントマターを推奨します：

---
name: my-skill
description: Optional description
---

# Skill content

アップロードファイルの命名

• ディレクトリモード：zip ファイル名は、ディレクトリのベース名に .zip を付加して作成されます。たとえば、ディレクトリ ./pdf の場合、アップロードされるファイル名は pdf.zip です。ベース名が空または . の場合は、skill.zip が使用されます。

• Zip モード：提供された zip ファイルの名前が、アップロードされるファイル名として使用されます。

実行フロー

1. [STEP 1/3] アップロード認証情報 (署名付き URL など) を取得します。

2. [STEP 2/3] ファイルのアップロード：ディレクトリはアップロード前に zip 圧縮され、zip ファイルは直接アップロードされます。

3. [STEP 3/3] Create Skill API を呼び出します。成功すると、コマンドは結果のスキル ID を出力します。

例

# SKILL.md を含むディレクトリからプッシュします
agentbay skills push ./my-skill

# 事前にパッケージ化された zip ファイルをプッシュします
agentbay skills push ./my-skill.zip

# 詳細出力を表示します
agentbay skills push ./my-skill -v

出力例

[STEP 1/3] Getting upload credential...
[STEP 2/3] Packing and uploading skill...
[STEP 3/3] Creating skill...

[SUCCESS] Skill created successfully!
[RESULT] Skill ID: <skill-id>

skills show - スキルの詳細表示

指定されたスキルの詳細を表示します。

構文

agentbay skills show <skill-id>

パラメータ

• <skill-id>：スキルの一意の識別子。これは、成功した skills push コマンドの [RESULT] 出力で返される ID です。

出力

• スキル ID：スキルの一意の識別子。

• name、description：スキルの名前と説明。長い説明は、読みやすさのために自動的に折り返され、インデントされます。

例

# スキルの詳細を表示します
agentbay skills show <skill-id>

# 詳細出力を表示します
agentbay skills show <skill-id> -v

login

構文

agentbay login

ログインプロセス

1. ローカルコールバックサーバーを起動します。

2. Alibaba Cloud 認証用のブラウザを開きます。

3. 認可コードを受信し、アクセストークンと交換します。

4. 認証トークンをローカル設定ファイルに保存します。

出力例

Starting AgentBay authentication...
Starting local callback server on port 3001...
Opening browser for authentication...
Browser opened successfully!
Waiting for callback on http://localhost:3001/callback...
Authentication successful!
Received authorization code: xxxxx...
Exchanging authorization code for access token...
Saving authentication tokens...
Authentication tokens saved successfully!
You are now logged in to AgentBay!

トラブルシューティング

ポート 3001 が使用中の場合は、次のコマンドを実行して確認してください。

• macOS/Linux: lsof -i :3001

• Windows: netstat -ano | findstr :3001

logout

構文

agentbay logout

ログアウトプロセス

1. サーバーサイドのリフレッシュトークンの取り消しを試みます。

2. ローカル設定ファイルから認証トークンをクリアします。

出力例

Logging out from AgentBay...
Revoking server tokens...
Refresh token revoked successfully
Clearing local authentication data...
Successfully logged out from AgentBay

version

構文

agentbay version

出力例

AgentBay CLI version 1.0.0
Git commit: abc1234
Build date: 2025-01-15
Environment: production
Endpoint: xiaoying-share.cn-shanghai.aliyuncs.com

出力フィールド

• Version: CLI のバージョン番号。

• Git commit: ビルド時の Git コミットハッシュ。

• Build date: ビルド日。

• Environment: 現在の環境 (プロダクションまたはプレリリース)。

• Endpoint: 現在の API エンドポイント。

設定ファイルの構造

設定ファイルは JSON フォーマットで、次の内容が含まれます：

• アクセス トークン

• リフレッシュ トークン

• ID トークン

• トークンタイプ

• 有効期限

トークン管理

CLI によるトークンの自動管理：

• 自動更新： CLI は現在のアクセス トークンの有効期限が切れる前に、リフレッシュ トークンを使用して新しいアクセス トークンを自動的に取得します。

• 安全なストレージ：トークンは、現在のユーザーのみがアクセスできるユーザーの設定ディレクトリに保存されます。

• トークンの検証： CLI は各 API 呼び出しの前にトークンの有効性を確認します。

環境変数

CLI は環境変数で設定することもできます：

• AGENTBAY_ENV：ランタイム環境。有効な値： prod (本番環境)、 pre (プレリリース環境)、 international (国際サイト)。

• AGENTBAY_CLI_ENDPOINT：デフォルトの API エンドポイントをオーバーライドするオプションの変数です。

認証

Q： ログイン時に「ポートが既に使用されています」というエラーが表示された場合、どうすればよいですか？

A： このエラーは、別のプログラムがポート 3001 を使用していることを意味します。解決するには、次の手順を実行してください。

1. ポートを使用しているプログラムを閉じます。

2. lsof -i :3001 (macOS/Linux) または netstat -ano | findstr :3001 (Windows) を使用してプロセスを見つけます。

3. プロセスを終了し、再試行します。

Q： 認証時にブラウザが自動的に開かない場合はどうすればよいですか？

A： CLI は認証 URL を表示します。それをブラウザにコピーして貼り付け、認証を完了してください。

Q： ログインプロセスがタイムアウトした場合はどうなりますか？

A： 認証は 5 分後にタイムアウトします。タイムアウトした場合は、agentbay login を再度実行してください。

Q： 現在のログイン状態を確認するにはどうすればよいですか？

A： agentbay image list など、認証が必要なコマンドを実行してください。ログインしていない場合、またはセッションの有効期限が切れている場合、CLI がログインを促します。

イメージ

Q： 利用可能なベースイメージを表示するにはどうすればよいですか？

A： agentbay image list --system-only を使用して、ベースイメージとして使用できるすべてのシステムイメージを表示します。

Q： イメージビルドが失敗した場合はどうすればよいですか？

A： 次の点を確認してください。

1. Dockerfile の構文が正しいことを確認してください。

2. 指定したベースイメージ ID が有効であることを確認してください。

3. Dockerfile の先頭にあるシステム定義のヘッダー行を変更していないことを確認してください。

4. -v オプションを使用して、詳細なエラーログを表示します。

5. agentbay image init -i <system-image-id> を実行してテンプレートをダウンロードします。システムイメージ ID は、agentbay image list --system-only を実行して確認できます。

Q： Dockerfile のどの部分を変更できませんか？

A： agentbay image init でダウンロードした Dockerfile テンプレートでは、最初の N 行 (N はシステムから返される数値) はシステムで定義されており、変更できません。コマンドが成功すると、編集不可能な行数が示されます。

[重要] Dockerfile の最初の 5 行はシステム定義であり、変更できません。
[重要] 5 行目以降のコンテンツのみを変更してください。

N 行目以降のコンテンツのみを変更できます。最初の N 行を変更すると、イメージビルドが失敗する可能性があります。

Q： イメージビルドのステータスを確認するにはどうすればよいですか？

A： agentbay image list を実行してビルドステータスを確認します。イメージとリソースの完全なステータスを表示するには、agentbay image status <image-id> を使用します。

Q： イメージのアクティベートにはどのくらいの時間がかかりますか？

A： アクティベートには通常 1〜2 分かかります。CLI はこのプロセス中に進捗状況を表示します。

Q： 複数のイメージを同時にアクティベートできますか？

A： はい。各イメージは独立して管理されるため、競合することなく複数のイメージを同時にアクティベートできます。

Q： イメージをディアクティベートするとデータは失われますか？

A： いいえ。イメージをディアクティベートすると、関連するコンピューティングリソースが解放されますが、イメージ自体は削除されず、再度アクティベートできます。

コマンドの使用方法

Q： コマンドのヘルプを表示するにはどうすればよいですか？

A: 任意のコマンドまたはサブコマンドのオプションと使用方法を表示するには、--help または -h オプションを使用します:

agentbay --help
agentbay image --help
agentbay image create --help

Q： 詳細ログを有効にするにはどうすればよいですか？

A： サブコマンドで -v または --verbose オプションを使用して、より詳細な出力を取得できます。

agentbay -v image create my-app -f ./Dockerfile -i code-space-debian-12

Q： 設定ファイルはどこにありますか？

A：

• macOS/Linux： ~/.config/agentbay/config.json

• Windows： %APPDATA%\agentbay\config.json

Q： 設定をリセットするにはどうすればよいですか？

A： 設定ファイルを削除してから、再度ログインしてください。

# macOS/Linux
rm ~/.config/agentbay/config.json

# Windows
del %APPDATA%\agentbay\config.json

エラー処理

Q： 「リクエスト ID」エラーが発生した場合はどうすればよいですか？

A： エラーメッセージにリクエスト ID が含まれている場合は、この ID を保存し、テクニカルサポートに連絡する際に提供してください。

Q： ネットワーク接続に問題がある場合はどうすればよいですか？

A： 次の点を確認してください。

1. インターネット接続が機能していることを確認してください。

2. ファイアウォールが接続をブロックしていないことを確認してください。

3. AgentBay サービスエンドポイントに到達できることを確認してください。

概要

AgentBay CLI を使用すると、本番環境とプレリリース環境を切り替えることができます。この機能は、主に内部開発およびテスト向けです。

環境

• 本番環境 (production)：公式用途向けのデフォルト環境です。

• プレリリース環境 (prerelease)：テストおよび確認用です。

• 国際サイト環境 (international)：国際サイトのサービスにアクセスできます。

切り替え方法

AGENTBAY_ENV=prerelease agentbay login

# macOS/Linux
export AGENTBAY_ENV=prerelease
agentbay login
agentbay image list

# Windows (PowerShell)
$env:AGENTBAY_ENV="prerelease"
agentbay login
agentbay image list

# macOS/Linux - ~/.zshrc または ~/.bashrc に追加します
echo 'export AGENTBAY_ENV=prerelease' >> ~/.zshrc
source ~/.zshrc

# Windows - システム環境変数に追加します

本番環境への切り戻し

# 環境変数を設定解除します
unset AGENTBAY_ENV

# または、明示的に本番環境に設定します
export AGENTBAY_ENV=production

現在の環境の確認

agentbay version を実行して、現在の環境を確認します：

agentbay version

出力の Environment フィールドに現在の環境が表示されます。

国際サイトの使用

海外リージョンで国際サイトを使用するには、環境を international に設定します。

環境変数

• AGENTBAY_ENV=international ：国際サイトを使用します。

• オプションのオーバーライド： AGENTBAY_CLI_ENDPOINT。

例 (現在のセッション向け)

# macOS/Linux
export AGENTBAY_ENV=international
agentbay login
agentbay image list

# Windows (PowerShell)
$env:AGENTBAY_ENV="international"
agentbay login
agentbay image list

変数を設定した後、agentbay version を実行して現在の環境とエンドポイントを確認します。

サポートされている環境値

• 本番環境： production、prod、または未設定 (デフォルト)。

• プレリリース環境： prerelease、pre、または staging。

• 国際サイト： international。

注意事項

リソース設定リファレンス

image activate コマンドでは、--cpu パラメーターと --memory パラメーターを使用してリソース設定をカスタマイズできます。どちらのパラメーターも整数値を受け付けます。

サポートされている vCPU とメモリの組み合わせ：