メインコンテンツまでスキップ

Bitrise CLIでの認証

Bitrise CLIは、bitrise buildやbitrise appなど、Bitriseアカウントを操作するすべてのコマンドでアクセストークンを必要とします。bitrise local runなど、お使いのコンピューター上でのみ実行されるコマンドでは必要ありません。

CLIは、次の 2 種類のトークンを受け付けます。

ログイン方法は次のとおりです。

Bitrise CLI 3.0.0 以降

bitrise authコマンドにはBitrise CLI 3.0.0 以降が必要です。更新するには、bitrise updateを実行してください。

ブラウザーを使ってログインするClick to copy link​

対話型ターミナルでは、bitrise auth loginを実行するとブラウザーが開き、Bitriseにログインできます。

bitrise auth login

ログイン後、CLIはパーソナルアクセストークンを保存して自動的に更新するため、再度ログインする必要はほとんどありません。セッションの有効期限が切れた場合は、CLIが再度 bitrise auth login --oauth を実行するよう案内します。

ブラウザーはローカルアドレス経由でログイン結果をCLIに返すため、CLIと同じコンピューター上で実行する必要があります。SSHで接続するリモートコンピューターでは、代わりにトークンを使ってログインしてください。

トークンを使ってログインするClick to copy link​

  1. パーソナルアクセストークンまたは workspace API トークンを作成します。

  2. bitrise auth login --with-tokenを実行し、CLIにトークンの入力を求められたら貼り付けます。

    CLIは、入力中のトークンを非表示にします。スクリプトからトークンを渡すには、標準入力に送ります。

    echo "$BITRISE_PAT" | bitrise auth login --with-token

    標準入力がターミナルでない場合、--with-tokenフラグがなくても bitrise auth login は標準入力からトークンを読み取ります。

CLIは、貼り付けたトークンを更新しません。有効期限が切れたら、新しいトークンで再度ログインしてください。

メールアドレスとパスワードを使ってログインするClick to copy link​

bitrise auth login --emailは、アカウントのメールアドレスとパスワードでBitriseにログインし、CLI用の新しいパーソナルアクセストークンを作成します。メールアドレスが確認済みである必要があります。

bitrise auth login --email [email protected]

CLIがパスワードの入力を求めます。代わりにスクリプトから渡すには、--password-stdinを追加し、パスワードを標準入力に送ります。

printf '%s' "$PASSWORD" | bitrise auth login --email [email protected] --password-stdin

CLIはトークンの作成にのみパスワードを使用し、保存はしません。貼り付けたトークンと同様に、CLIはこのトークンも更新しません。

CLIがパスワードを送信する先

CLIは、メールアドレスとパスワードを web_base_url 設定のホストに送信します。デフォルトは app.bitrise.io です。この設定はグローバル設定ファイルまたは Environment Variable でのみ変更でき、.bitrise-cli.yml ファイルでは変更できません。これにより、クローンしたリポジトリがパスワードを別のサーバーに送信することを防ぎます。Base URLsを参照してください。

BITRISE_TOKEN Environment Variable を使うClick to copy link​

BITRISE_TOKEN Environment Variable が設定されている場合、CLIは保存済みのトークンの代わりにそれを使用します。誰も対話的にログインできないCIで使用してください。

Bitriseは、ビルドで BITRISE_TOKEN を設定しません。ビルドでCLIを使用するには、次の手順を実行します。

  1. パーソナルアクセストークンまたは Workspace API トークンを作成します。

  2. キー BITRISE_TOKEN のSecretとして、projectに追加します。Secretsを参照してください。

  3. Script StepでCLIを呼び出します。

    bitrise build list --status failed

    ビルド内では、--app フラグのないコマンドは、そのビルドが実行されるプロジェクトを対象に動作します。

保存済みトークンの確認と削除Click to copy link​

bitrise auth statusは、CLIにトークンがあるかどうか、およびその取得元(BITRISE_TOKEN Environment Variable または保存済みトークン)を表示します。トークンの種類と、ブラウザーログインの場合は有効期限も表示します。トークン自体は表示されません。

bitrise auth status
bitrise auth status --format json

保存済みトークンを削除するには、bitrise auth logoutを使用します。BITRISE_TOKENで設定したトークンには影響しません。

注記

CLIは、トークンを ~/.config/bitrise/cli/auth.yaml(または $XDG_CONFIG_HOME/bitrise/cli/auth.yaml)に保存します。このファイルは、お使いのユーザーのみが読み取れます。新しくログインすると、以前のトークンは置き換えられます。このファイルはCLIの設定ファイルとは別なので、トークンを共有せずに設定だけを共有できます。

関連情報