インストールと認証

mcms-cliのインストールからmicroCMSへの認証までを説明します。環境変数と名前付きプロファイルの使い分け、APIキーをOSのキーチェーンへ保存する方法、接続先と認証情報の取得元を作業前に確認するコマンドを、ローカル開発とCIの両方を想定して紹介します。

必要な環境

Node.js 20以上
操作対象のmicroCMSサービス
必要な権限を持つAPIキー

インストール

グローバルにインストールする場合は、次のコマンドを実行します。

npm install -g @mrmtsu/mcms-cli
microcms --help

一時的に試す場合は、インストールせずにnpxから実行できます。

npx @mrmtsu/mcms-cli --help

CIで環境変数を使う

CIや非対話実行では、service domainとAPIキーを環境変数で渡します。

export MICROCMS_SERVICE_DOMAIN=<service-domain>
export MICROCMS_API_KEY=<api-key>

microcms auth status --json
microcms config doctor --json

APIキーをコマンド引数へ直接書くと、シェル履歴やプロセス一覧に残る可能性があります。環境変数、標準入力、OSキーチェーンのいずれかを利用してください。

名前付きプロファイルを使う

複数のmicroCMSサービスを切り替える場合は、名前付きプロファイルを利用できます。

microcms auth profile add staging \
  --service-domain <service-domain> \
  --set-default \
  --json

printf '%s' '<api-key>' | \
  microcms auth login \
  --profile staging \
  --api-key-stdin \
  --json

profile addが保存するのはservice domainです。APIキーは別途auth loginでOSキーチェーンへ保存します。

利用するプロファイルは環境変数でも選択できます。

export MICROCMS_PROFILE=staging
microcms auth status --json

認証情報の解決順

APIキーは、コマンド指定、環境変数、選択中プロファイルのキーチェーン、service domainに対応するキーチェーンの順で解決されます。

service domainは、コマンド指定、環境変数、選択中プロファイル、設定ファイルの順で解決されます。

想定と異なる接続先への書き込みを防ぐため、作業開始時にはauth statusとconfig doctorを実行してください。

インストールと認証

必要な環境