メインコンテンツへスキップ

mabl CLIのインストールと設定

Eva Ferreira
  • 更新

mabl CLI で作業を始めるには、次のインストール手順に従ってください。

Nodeのバージョンを確認してください

mabl CLIは、Node.jsパッケージです。インストールには、現在サポートされているNode.jsのLTSバージョン（現在はバージョン20以上）が必要です。Nodeがインストールされているかどうかや現在のバージョンを確認するには、ターミナルまたはコマンドプロンプトを開き、node -vを実行してください。

mabl CLIのインストール

次のコマンドを実行して、mabl CLI をインストールしてください。

npm install -g @mablhq/mabl-cli

このコマンドは、Node Package Manager（npm）を使って、mabl CLI をあなたのマシンにグローバルにインストールします。

mabl CLI が正常にインストールされたことを確認するには、mabl --version を実行してください。インストールが成功していれば、mabl CLI はインストールされている CLI のバージョンを返します。

successful_cli_installation.png

インストールが成功しなかった場合は、一般的なインストール課題への対処方法について、トラブルシューティング記事をご覧ください。

CI環境でmabl CLIをインストールする方法について詳しくは、こちらの記事をご覧ください。

mabl CLI を認証する

mabl CLI の使用を開始するには、次のコマンドを実行して認証してください。

mabl auth login

このコマンドは、mabl CLI に mabl のログインページをブラウザウィンドウで開くよう促します。認証を完了するには、次のステップを実行してください。

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

次のコマンドを実行して、認証が正常に完了しているか確認してください。

mabl auth info
Logged in as user [john@company.com] Login expires in [3 hours, 23 minutes]

コマンドを調べるには、mabl -h を実行してください。各コマンドの詳細を知りたい場合は、そのコマンドに -h オプションを追加しましょう。CLIツールを初めて使う方は、mabl CLIコマンドの使い方を詳しく解説したこちらの記事もご覧ください。

転送プロキシを設定する

フォワードプロキシを使用しているネットワークで mabl CLI を使う場合は、mabl config コマンドを使ってフォワードプロキシを設定できます。

# add a proxy with no credentials on port 3128
mabl config set http.proxy http://proxy.mycompany.com:3128

# add a proxy using credentials on port 3128
mabl config set http.proxy http://“username:password”@proxy.mycompany.com:3128

# delete the current proxy setting
mabl config delete http.proxy

指定したURLが無効であるというエラーが表示された場合は、Node.jsのバージョンが20以上であることを確認してください。ログイン時に407エラーが発生した場合は、プロキシ認証エラーです。上記でパスワードとユーザー名が正しく設定されているか確認してください。

プロキシのタイプによっては、mabl config setを使って次の設定を追加することもできます。

オプション 説明 デフォルト値
http.proxyMode プロキシを使用するトラフィックを指定します mabl
http.sslVerify SSL検証を有効化または無効化します true
http.proxyType 使用するプロキシ実装を指定します legacy

値が未設定の場合はデフォルト値が使用される

設定されていない設定オプションがある場合、その設定オプションはmabl config listの一覧表示で---と表示され、上の表のデフォルト値が使用されます。

同様に、mabl config deleteコマンドを使ってプロキシ設定値を削除した場合も、その設定オプションは未設定 (---) と表示され、デフォルト値が使用されます。

http.proxyMode

デフォルトでは、mabl固有のリクエストのみがフォワードプロキシを通過します。http.proxyMode設定フラグを使用すると、プロキシを適用するトラフィックを指定できます。

http.proxyMode 説明
mabl mablトラフィックのみに適用されます (デフォルト設定)
test - テスト テストトラフィックのみに適用されます
all mablトラフィックとテストトラフィックの両方に適用されます (デフォルト設定)
none プロキシは適用されません

プロキシモードの変更

http.proxyMode noneは、プロキシ設定のテストを行う場合や、作業環境 (オフィスと自宅など) の切り替え時にプロキシをオフにする場合に便利です。

http.sslVerify

デフォルトでは、CLIはサーバー証明書が既知の認証局によって発行されたものであるかどうかを検証します。プロキシがHTTPSトラフィックをインターセプトしている場合、証明書の検証に失敗することがあります。プロキシを使用していてSSL検証が失敗する場合は、以下のように、証明書の検証を無効にすることができます。これは、必要な場合にのみ行うようにしてください。

# disable SSL verification
mabl config set http.sslVerify false

# delete the current ssl verification setting to use the default
mabl config delete http.sslVerify

http.proxyType

レガシーなプロキシライブラリには、http.sslVerifyの設定が順守されないという問題があることが知られています。この場合、常にSSL証明書の検証が行われ、自己署名証明書を使用するプロキシでエラーが発生します。この問題を解消するため、mablでは証明書の検証を正しく行う新しいプロキシ実装を追加しました。http.proxyTypeの設定では、これらのプロキシ実装を切り替えることができます。指定できる値は、currentとlegacy (デフォルト) です。

  • current: プロキシライブラリでhttp.sslVerifyフラグが正しく実行されます。
  • legacy: 既存のプロキシ実装であり、http.sslVerifyフラグを順守しません。

すべての場合にcurrent設定を使用したうえで、お使いのプロキシ設定でcurrent設定がうまく機能しない場合にのみ、legacy設定に戻すことをお勧めします。

システム要件

現在、Windows Subsystem for Linux (WSL) でのCLIの使用はサポートされていません。

CLIのアンインストール

mabl CLIを削除するには、次のコマンドを実行します。

npm remove -g @mablhq/mabl-cli

関連記事