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

Bitrise CLIの設定

Bitrise CLIは設定ファイルからdefault valueを読み取るため、すべてのコマンドに同じフラグを毎回渡す必要はありません。たとえば、リポジトリが属するprojectを保存したり、すべてのコマンドでJSONを出力するように設定したりできます。

Bitrise CLI 3.0.0 以降

このページのコマンドと設定キーには、bitrise config Bitrise CLI 3.0.0 以降が必要です。更新するには、bitrise updateを実行してください。

設定ファイルの場所Click to copy link​

CLIは、最大3つのファイルから設定を読み取ります。優先順位は高い順に次のとおりです。

  1. レガシー設定ファイル ~/.bitrise/config.json。レガシー設定ファイルを参照してください。
  2. ディレクトリごとの設定ファイル .bitrise-cli.yml。CLIは、カレントディレクトリから順に各親ディレクトリを探し、最初に見つかったものを使用します。
  3. グローバル設定ファイル ~/.config/bitrise/cli/config.yml。~/.config以外の場所から読み取る場合は、$XDG_CONFIG_HOMEを設定してください。場所を確認するには、bitrise config pathを実行します。

いずれのファイルにも値が設定されていない場合、CLIは組み込みのデフォルト値を使用します。

フラグとEnvironment Variablesは、すべての設定ファイルより優先されます。たとえば、CLIは次の順序でコマンドのプロジェクトを決定します。

  1. --appフラグ。
  2. BITRISE_APP_ID Environment Variable、次にBITRISE_APP_SLUG。
  3. .bitrise-cli.ymlファイルのapp_idキー。
  4. グローバル設定ファイルのapp_idキー。

~/.config($XDG_CONFIG_HOMEを設定している場合はそちら)が書き込み可能であることを確認してください。書き込みできないと、bitrise local setupやプラグインのコマンドが失敗することがあります。

設定キーClick to copy link​

キー設定内容Environment Variableデフォルト
app_id--appを渡さない場合にコマンドが対象とするプロジェクト。BITRISE_APP_ID、BITRISE_APP_SLUGなし
default_workspace_id--workspaceを渡さない場合にコマンドが対象とするWorkspace。BITRISE_WORKSPACE_ID1つだけある場合はそのWorkspace
output出力形式: raw、json、ymlのいずれか。BITRISE_OUTPUTraw
themeカラーテーマ: auto、dark、light、noneのいずれか。BITRISE_CLI_THEMEauto
api_base_urlBitrise APIホスト。BITRISE_API_BASE_URLhttps://api.bitrise.io/v0.1
web_base_urlBitrise websiteホスト。メールアドレスとパスワードでのログインや、bitrise app view --webでのプロジェクトの表示に使用されます。BITRISE_WEB_BASE_URLhttps://app.bitrise.io
rde_api_base_urlRemote Dev Environment APIホスト。BITRISE_RDE_API_BASE_URLhttps://api.bitrise.io/rde

Bitriseビルド内では、BITRISE_APP_SLUGとBITRISE_WORKSPACE_IDが常に設定されるため、フラグを渡さない限り、コマンドはそのビルド自身のプロジェクトとWorkspaceを対象に動作します。

アクセストークンは設定キーではなく、別のファイルに保存されます。Authenticating with the Bitrise CLIを参照してください。

ベースURLClick to copy link​

設定の優先順位には3つの例外があります。ベースURLを定義するキーは、グローバル設定ファイルでのみ設定できます。CLIは、.bitrise-cli.ymlファイル内のこれらのキーを無視します。

  • api_base_url
  • web_base_url
  • rde_api_base_url

対応するEnvironment Variablesは、グローバル設定ファイルよりも優先されます。

  • BITRISE_API_BASE_URL
  • BITRISE_WEB_BASE_URL
  • BITRISE_RDE_API_BASE_URL

3つとも、CLIが認証情報の送信先とするホストを設定するものです。また、CLIは、確認なしに任意の親ディレクトリの.bitrise-cli.ymlを読み取ります。これらのキーをそこから読み取る場合、クローンしただけのリポジトリによって、ログインが制御できないサーバーにリダイレクトされるおそれがあります。

グローバル設定ファイルの管理Click to copy link​

グローバル設定ファイルの読み取りと書き込みには、bitrise configコマンドを使用します。

コマンド動作
bitrise config set KEY VALUEキーを設定します。
bitrise config get KEYキーの値を出力します。
bitrise config unset KEYキーを削除します。
bitrise config listファイルに保存されているすべてのキーを出力します。--format jsonまたは--format ymlを指定できます。
bitrise config pathファイルの場所を出力します。

たとえば、my-app-idをデフォルトのプロジェクトにするには、次のようにします。

bitrise config set app_id my-app-id
注記

bitrise app createは、新しいプロジェクトのIDもapp_idとして保存します。

bitrise config listが表示するのは、グローバル設定ファイルに保存されている内容のみです。コマンドの実行時には、フラグ、Environment Variables、.bitrise-cli.ymlファイルによってこれらの値が上書きされることがあります。

リポジトリをプロジェクトに固定するClick to copy link​

リポジトリのルートに.bitrise-cli.ymlファイルを追加すると、そのリポジトリ内で実行するすべてのコマンドに対して、プロジェクトとworkspaceを設定できます。bitrise configコマンドはこのファイルを書き込まないため、手動で作成してください。

app_id: my-app-id
default_workspace_id: my-workspace-id

これで、リポジトリ内のどこで実行しても、bitrise build listやbitrise yml getは、--appフラグなしでmy-app-idを対象に動作します。

app_idとdefault_workspace_idのほかに、このファイルではoutputとthemeも設定できます。ベースURLは設定できません。

レガシー設定ファイルClick to copy link​

3.0.0より前のBitrise CLIのバージョンは、設定を~/.bitrise/config.jsonに保存していました。このファイルには内部状態のみが含まれます。最後のbitrise local setupのバージョンと、CLIが自身およびプラグインの更新を最後に確認した日時です。編集する必要はありません。

このファイルが存在する場合、CLIはそれを引き続き読み取り、その値が優先されます。CLIがこれらの値のいずれかを更新するときは、config.jsonとconfig.ymlの両方に書き込みます。新規インストールでは、config.jsonは作成されません。

関連情報