コンテンツにスキップ

2. コマンドラインインターフェース(CLI)

Build CLIを使用すると、アプリケーションとアカウントにコマンドラインからアクセスできます。ダッシュボードはビジュアルなワークフローや個別のタスクに最適ですが、CLIはデプロイのスクリプト化、設定変更の自動化、ターミナルを離れずにアプリを素早く確認したい場合に威力を発揮します。

このセクションでは、CLIのインストール、アカウントへの認証、利用可能なすべてのコマンドのリファレンス、および便利な操作のセクションを説明します。

CLIのインストールにはCrystalバージョンの使用を推奨します(Rubyジェムはメンテナンスが終了しています)。

Homebrewでインストールできます:

$ brew install buildio/cli/bld

LinuxでもHomebrewでインストールできます。

Ubuntuの場合は、まずこの依存関係をインストールします:

$ apt install libpcre3-dev
$ brew install buildio/cli/bld

使用しているディストリビューションのパッケージマネージャーを使ってCrystal(言語)とShards(パッケージマネージャー)をインストールします。

Fedoraの場合はdnfを使用できます:

$ sudo dnf install crystal
$ sudo dnf install libssh2-devel

Ubuntuの場合はaptを使用できます:

$ sudo apt install crystal
$ sudo dnf install shards

パッケージマネージャーを自動判別する汎用Linuxインストール方法もあります。

crystal 1.16が必要です。PPAから入手できます:
https://crystal-lang.org/install/

スクリプトを事前に確認する場合:
https://crystal-lang.org/install.sh

以下でソースリストに追加されます:

$ curl -fsSL https://crystal-lang.org/install.sh | sudo bash`

Crystalをインストールしたら、libssh2-1-devパッケージがインストールされていることを確認してから、(公開)GitHubアカウントからCrystal CLIを直接ダウンロードします:

$ sudo apt install libssh2-1-dev
$ git clone https://github.com/buildio/cli.git
$ cd cli/ && shards build

コマンドラインからBuildアプリを操作するには、まずCLIをBuildアカウントで認証する必要があります。

認証するには、loginコマンドを実行します:

$ bld login

これにより、デフォルトのWebブラウザが開き、Buildのログインページに移動します。サインインしてCLIを承認すると、認証情報がローカルに保存され、コマンドの使用を開始できます。

現在のユーザーを確認することでログイン済みかどうかを確認できます:

$ bld whoami
you@example.com

組織がシングルサインオン(SSO)を使用している場合、またはBuildクラスターに直接認証する必要がある場合は、OIDCログインコマンドを使用します:

$ bld oidc-login

これはOpenID Connectを使用して認証します。特定のエンタープライズ設定やクラスターレベルのリソースへのアクセス時に必要になる場合があります。

ログインセッションは、明示的にログアウトするかトークンが期限切れになるまで有効です。非アクティブ期間後に認証エラーが発生した場合は、bld loginを再度実行して認証情報を更新してください。

Build CLIは、管理するリソースに基づいてコマンドをグループに整理しています。以下は利用可能なすべてのコマンドの概要です。

これらのオプションはすべてのコマンドで使用できます:

コマンドのヘルプを表示するには、—helpフラグを使用します:

$ bld apps:create --help

またはhelpコマンドを使用します:

$ bld help apps:create

アプリケーションをHerokuからBuildに移行する場合、両方のCLIツールを使用して環境設定を素早く転送できます。

HerokuからConfig Varをインポートする

Section titled “HerokuからConfig Varをインポートする”

HerokuアプリのConfig Varは2つのステップでエクスポートし、Buildにインポートできます。
まず、Heroku CLIを使用してConfig Varをファイルにエクスポートします:

$ heroku config -a your-heroku-app -s > env-backup

-sフラグは変数をシェル形式(KEY=value)で1行ずつ出力します。これによりインポートが簡単になります。

次に、ファイルをBuild CLIにパイプして、新しいアプリにすべての変数を設定します:

$ cat env-backup | xargs bld config:set -a your-build-app

これによりバックアップファイルの各行が読み取られ、config:setコマンドの引数として渡され、環境設定全体を一度に再現します。

インポート後、Config Varが正しく転送されたことを確認します:

$ bld config:list -a your-build-app

この出力を元のHeroku設定と比較して、漏れがないことを確認します。

env-backupファイルにはAPIキーやデータベース認証情報などの機密情報が含まれています。インポートが完了したら必ず削除し、バージョン管理にコミットしないようにしてください:

$ rm env-backup