CircleCI のローカル CLI のインストール

CircleCI コマンドラインインターフェース (CLI) を使用すると、CircleCI の高度でパワフルなツールをターミナルで使えるようになります。 CLI は、クラウド版と Server v3.x 以上のインストールでサポートされます。 Server v2.x をご利用のお客様は、 旧バージョンの CLI インストールのセクションをお読みください。

CLI を使用すると、以下のような作業が行えます。

• CI の設定ファイルのデバッグとバリデーション
• ローカルでのジョブの実行
• CircleCI API のクエリ
• Orb の作成、パブリッシュ、表示、管理
• コンテキストの管理

このページでは、CircleCI CLI のインストールと使用方法について説明します。 CI/CD と CircleCI のコンセプトに関する基本的な知識があることを前提としています。 CircleCI アカウントとサポート対象の VCS のアカウントを用意し、ターミナルを開いたら準備は完了です。

CircleCI CLI のインストールには複数の方法があります。

通常、CircleCI CLI のインストールには、以下のセクションで説明するパッケージマネージャーのいずれかを使うことをお勧めします。

以下のコマンドを実行すると、CircleCI CLI、Docker と共に、 Snap パッケージに付属のセキュリティ機能と自動更新機能がインストールされます。

sudo snap install docker circleci
sudo snap connect circleci:docker docker

Snap パッケージを使って CLI をインストールする場合、この Docker コマンドでは、以前にインストールした Docker のバージョンではなく、Docker Snap が使用されます。 セキュリティ上の理由から、Snap パッケージは $HOME 内でしかファイルを読み書きできません。

macOS で Homebrew を使用している場合は、以下のコマンドで CLI をインストールできます。

brew install circleci

Mac 版の Docker をインストールされている場合は、代わりに以下のコマンドを使用します。

brew install --ignore-dependencies circleci

Windows ユーザー向けには、 Chocolatey パッケージを提供しています。

choco install circleci-cli -y

Mac と Linux の場合

curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | bash

CircleCI の CLI ツールは、デフォルトで /usr/local/bin ディレクトリにインストールされます。 /usr/local/bin への書き込みアクセス権を持っていない場合は、上記コマンドのパイプと bash の間に sudo を挿入して実行する必要があります。

curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | sudo bash

bash を呼び出す際に DESTDIR 環境変数を定義して、別の場所にインストールすることも可能です。

curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | DESTDIR=/opt/bin bash

CLI を手動でダウンロードしてインストールする場合は、 GitHub のリリースページをご確認ください。 システム上の特定のパスに CLI をインストールしたい場合は、この方法が最適です。

更新の有無を手動で確認するだけでインストールを行わない場合は、次のコマンドを使用します。

  circleci update check

Linux と Windows のインストールでは、次のコマンドを使用して CLI の最新バージョンに更新できます。

  circleci update

Homebrew を使用した macOS インストールの場合は、次のコマンドを実行して更新する必要があります。

  brew upgrade circleci

CLI の最新バージョンは CircleCI パブリックオープンソースプロジェクトです。 旧バージョンの CLI をインストールしている場合は、以下のコマンドを実行して更新を行い、最新バージョンの CLI に切り替えてください。

circleci update
circleci switch

インストールディレクトリ /usr/local/bin への書き込みアクセス権が付与されていないユーザーがこのコマンドを実行すると、sudo を使用するように求められることがあります。

CLI を使用する前に、 Personal API Token タブで CircleCI の API トークンを生成する必要があります。 トークンを取得したら、以下を実行して CLI を設定します。

circleci setup

このコマンドを実行すると、設定を行うように求められます。 クラウド版 CircleCI で CLI を使用している場合は、デフォルトの CircleCI ホストを使用します。 CircleCI Server を使用している場合は、値をインストール用のアドレスに変更します (例: circleci.your-org.com)。

CLI を使用して設定をローカルでバリデーションすると、.circleci/config.yml をテストするために追加のコミットをプッシュする必要がなくなります。

設定をバリデーションするには、.circleci/config.yml ファイルがあるディレクトリに移動し、以下を実行します。

circleci config validate
# Config file at .circleci/config.yml is valid

CircleCI CLI のアンインストールに使用するコマンドは、元のインストール方法によって異なります。

Snap を使用した Linux の場合:

sudo snap remove circleci

Homebrew を使用した macOS の場合:

brew uninstall circleci

Chocolatey を使用した Windows の場合:

choco uninstall circleci-cli -y --remove dependencies

curl を使用したアンインストール: circleci 実行可能ファイルを usr/local/bin から削除します。

現在、macOS と Linux のディストリビューションでは、CircleCI Server v2.x インストール環境で実行できるのは旧バージョンの CircleCI CLI のみです。 旧バージョンの CLI をインストールするには、次の手順を実行します。

1. Docker のインストール手順に従って、Docker をインストールし、設定します。
2. 以下のコマンドを実行して、CLI をインストールします。

$ curl -o /usr/local/bin/circleci https://circle-downloads.s3.amazonaws.com/releases/build_agent_wrapper/circleci && chmod +x /usr/local/bin/circleci

CLI (circleci) は /usr/local/bin ディレクトリにダウンロードされます。 /usr/local/bin への書き込みアクセス権を持っていない場合は、上記のコマンドを sudo で実行する必要がある場合があります。 CLI はアップデートの有無を自動的に確認し、アップデートがあった場合はメッセージが表示されます。

• 実行環境の概要