環境コマンド
mabl CLIでの環境の管理
mabl CLIでは、ワークスペースの環境のリスト表示、クエリ、作成、更新、削除をプログラムで実行できます。
mabl environments list
mabl environments list
コマンドは、ワークスペース内の環境をリスト表示します。これには、環境ID、環境名、各環境の作成日などの情報が含まれます。
オプション
オプション | 詳細 |
---|---|
--limit , -l | 返す環境の数。デフォルトは10です。 |
--output , -o | 出力形式を指定します。デフォルトはテーブルです。"yaml" または "json" のいずれかを指定できます。 |
例
# List 20 environments in the workspace
mabl environments list --limit 20
# List five environments in json format
mabl environments list --limit 5 --output json
mabl environments describe
mabl environments describe
コマンドは、特定の環境の詳細情報を返します。これには以下の内容
- 含まれます。
- 作成日時と作成者
- 最終更新日時と更新者
- ページ操作速度
- Link Agentの設定
- 環境がスナップショットに関連付けられているかどうか
オプション
オプション | 詳細 |
---|---|
--decrypt | 出力で環境変数を返します。 |
--output , -o | 出力形式を指定します。デフォルトはyamlです。"json" または "yaml" のいずれかを指定できます。 |
例
# Describe an environment in JSON format
mabl environments describe <環境ID> --format json
# Describe an environment, including its environment variables
mabl environments describe <環境ID> --decrypt
mabl environments create
mabl CLIでmabl environments create
を使用して環境を作成すると、新しく作成した環境のIDが返されます。
オプション
オプション | 詳細 |
---|---|
--application-id | この環境に関連付けるアプリケーションのID |
--app-url | このアプリケーションと環境の組み合わせに関連付けるWebアプリケーションURL |
--api-url | このアプリケーションと環境の組み合わせに関連付けるAPI URL |
--name , -n | 環境の名前 |
--description | 環境の説明 |
--variables | 環境変数のキーと値のペアをvar1:value1の形式で指定します。 |
--link | この環境で使用するLink Agentの名前 |
--mabl-branch | この環境に関連付けるmablブランチの名前。この環境に対して実行されるテストは、このブランチのバージョンを使用します。指定されたブランチにテストが存在しない場合、テストはmaster上で実行されます。 |
--preview | プレビュー環境としてマークする場合はtrueに設定します。 |
例
# Create an environment associated with an application and app URL
mabl environments create -n <環境名> --application-id <アプリケーションID> --app-url https://www.example.com
# Create a preview environment with variables
mabl environments create -n <環境名> --application-id <アプリケーションID> --app-url https://www.example.com --variables foo:bar --preview true
mabl environments update
mabl environments update
を実行して環境を更新します。環境が更新されたことを示すメッセージが返されます。更新後の値を表示するには、mabl environments describe
を実行します。
オプション
オプション | 詳細 |
---|---|
--name , -n | 環境の名前を更新します。 |
--description | 環境の説明を更新します。 |
--variables | 環境変数のキーと値のペアをvar1:value1の形式で更新します。 |
--link | この環境で使用するLink Agentの名前を更新します。 |
--mabl-branch | この環境に関連付けるmablブランチを更新します。この環境に対して実行されるテストは、このブランチのバージョンを使用します。指定されたブランチにテストが存在しない場合、テストはmaster上で実行されます。 |
--preview | プレビュー環境としてマークする場合はtrueに変更します。 |
例
# Update the environment variables
mabl environments update <環境ID> --variables var1:value1 var2:value2
# Update an environment to run on a mabl branch called "test-branch"
mabl environments update <環境ID> --mabl-branch test-branch
mabl environments urls list
mabl environments urls list
コマンドは、特定の環境に関連するアプリケーションおよびアプリケーションURLのリストを返します。
オプション
オプション | 詳細 |
---|---|
--application-id , -a | URLsのアプリケーションIDにてURLsをフィルターします。 |
--limit , -l | 返すURLの数を指定します。 |
--output , -o | 出力形式を指定します。"json" または "yaml" のいずれかを指定できます。 |
例
# Return up to 5 environment URLs
mabl environments urls list <環境ID> --limit 5
# Return environment URLs in json format
mabl environments urls list <環境ID> --output json
mabl environments urls add
特定の環境に関連するアプリケーションに1つ以上の新しいWebアプリケーションURLまたはAPI URLを追加します。
オプション
オプション | 詳細 |
---|---|
--application-id | この環境に関連付けるアプリケーションのID。このオプションは必須です。 |
--app-url | このアプリケーションと環境の組み合わせに関連付けるWebアプリケーションURL |
--api-url | このアプリケーションと環境の組み合わせに関連付けるAPI URL |
例
# Associate an application and environment with three new web application URLs
mabl environments urls add <環境ID> --application-id <アプリケーションID> --app-url https://www.url1.com https://www.url2.com https://www.url3.com
# Associate an application and environment with a web application URL and an API URL
mabl environments urls add <環境ID> --application-id <アプリケーションID> --app-url https://www.example.com --api-url https://www.api.example.com
mabl environments delete
環境を削除します。
mabl environments delete <環境ID>
Updated 9 days ago