mabl CLI を利用する

この記事は、コマンドラインツールに慣れていない新規ユーザーの方々を対象にしています。この記事に記載されたコマンドに従ってmabl CLIにログインし、mabl CLIコマンドの詳細と各種コマンドの機能を把握してください。

認証

ローカルマシンでmabl CLIを使用するには、次のコマンドを実行します。

mabl auth login

このコマンドを実行すると、mablのログインページがブラウザーウィンドウに表示されます。次の手順を実行して認証を行います。

通常の手段 (ユーザー名とパスワード、Google認証システム、またはSSO) を使用してmablにログインします。
ブラウザーウィンドウから認証コードをコピーします。
認証コードをmabl CLIに貼り付けます。
Enterキーを押すと、ログインが完了します。

APIキーによる認証

mabl CLIをスクリプトに組み込む場合、APIキーで認証を行うことができます。

mabl auth activate <APIキー>

mabl CLIを試す

mabl CLIには、mablテストをワークフローに統合するためのさまざまなコマンドが含まれています。mabl CLIで使用可能な各種コマンドの詳細を表示するには、次のコマンドを実行します。

mabl -h

任意のmabl CLIコマンドに-hまたは--helpオプションを追加すると、詳細を表示することができます。たとえば、環境を管理するコマンドの詳細を表示するには、次のコマンドを実行します。

mabl environments -h

mabl environments updateなどのサブコマンドで使用可能なオプションの詳細を表示するには、同じく-hオプションを追加します。例を示します。

mabl environments update -h

mabl CLIコマンドのコンポーネント

実行するコマンドによっては、引数またはオプションが必要になる場合があります。

引数

一部のmabl CLIコマンドには引数が必要です。引数とは、コマンドに渡す値です。たとえば、mabl CLIでブランチを作成するには、新しいブランチの名前を引数として指定する必要があります。

mabl branches create <ブランチ名>

オプション

オプションは「フラグ」とも呼ばれ、コマンドの動作に一部修正を加えます。オプションの前にはハイフンを1つまたは2つ付加します。たとえば、ワークスペースのDataTableのリストをJSON形式で返す場合、mabl datatables listコマンドに--outputオプションを付加します。

mabl datatables list --output json

mablリソースID

mabl CLIのコマンドの多くには、引数またはオプションの引数としてmablリソースIDを指定する必要があります。たとえば、ローカルでのアドホック実行をトリガーするには、オプション--idにテストIDを指定する必要があります。

mabl tests run --id <テストID>

mablリソースIDは、listコマンドで取得できます。たとえば、ワークスペースのテストのmablリソースIDを取得するには、次のコマンドを実行します。

mabl tests list

📘
mablリソースIDの取得方法に関する詳細、ヒント、スクリーンショットについては、こちらの記事を参照してください。

次のステップ

mabl CLIの基本事項を説明しました。次は、mabl CLIでテストのアドホック実行をトリガーしてみましょう。