Appearance
インストール
概要
cdm のインストール方法と、インストーラの挙動(バイナリの配置先、PATH の自動設定、その無効化)について説明します。導入手順の流れは はじめに を、インストール後の更新は cdm update を参照してください。
インストールコマンド
macOS / Linux:
sh
curl -fsSL https://cli-dist.codatum.com/install.sh | shWindows(PowerShell):
powershell
irm https://cli-dist.codatum.com/install.ps1 | iexインストーラは OS と CPU アーキテクチャを自動判定し、最新版の cdm をダウンロードして配置します。あわせて、cdm を PATH から呼び出せるようにシェル設定を自動で行います。
バイナリの配置先
| OS | 配置先 |
|---|---|
| macOS / Linux | ~/.local/bin/cdm |
| Windows | %LOCALAPPDATA%\Programs\cdm\bin\cdm.exe |
配置先を変更したい場合は、環境変数 CDM_INSTALL_DIR で指定できます。
PATH の自動設定
インストーラは、cdm をコマンド名で呼び出せるように、配置先を PATH へ追加する設定を自動で行います。挙動は OS によって異なります。
macOS / Linux
ログインシェルに応じて、次のシェル設定ファイルに PATH を通す設定を追記します。ログイン時・ターミナル起動時のどちらでも cdm が使えるように、両方のファイルに追記します。
| ログインシェル | 追記先 |
|---|---|
| zsh | ~/.zprofile と ~/.zshrc |
| bash | ログイン用ファイル(~/.bash_profile など)と ~/.bashrc |
WARNING
追記した設定は実行中のターミナルには自動では反映されません。 新しいターミナルを開くか、インストーラが表示する案内に従って source コマンドを実行してから cdm を利用してください。
- 追記は冪等で、再インストールや
cdm updateで重複して追記されることはありません - サポート対象外のシェル(fish など)では、シェル設定ファイルは変更せず、手動で PATH を通すための案内を表示します
Windows
ユーザー環境変数の PATH に配置先を追加します(管理者権限は不要です)。実行したターミナルでは即座に cdm を使えますが、他のターミナルや IDE では新しいセッションを開始してから利用してください。
PATH の自動設定を無効化する
CI やコンテナなど、シェル設定を自分で管理したい場合は、PATH の自動設定を無効化できます。無効化する手段は次の通りで、いずれの OS でも環境変数が利用できます。
| 手段 | 対象 |
|---|---|
環境変数 CDM_SKIP_PATH_SETUP=1 | macOS / Linux / Windows 共通 |
--skip-path-setup フラグ | macOS / Linux(スクリプトに引数を渡す場合) |
-SkipPathSetup スイッチ | Windows |
例:
sh
# macOS / Linux(フラグ)
curl -fsSL https://cli-dist.codatum.com/install.sh | sh -s -- --skip-path-setupsh
# macOS / Linux(環境変数。パイプ右側の sh に渡す)
curl -fsSL https://cli-dist.codatum.com/install.sh | CDM_SKIP_PATH_SETUP=1 shpowershell
# Windows(PowerShell)
$env:CDM_SKIP_PATH_SETUP=1; irm https://cli-dist.codatum.com/install.ps1 | iexCI での利用例は GitHubで管理 も参照してください。
インストールの確認
インストールが成功したか、バージョンを表示して確認します。
sh
cdm --version新しいターミナルで cdm が見つからない場合は、PATH の自動設定 を参照してください。
アップデート
すでに cdm をインストール済みの場合は、cdm update で最新化できます。cdm update は実行中のバイナリを同じ場所に置き換えます。
sh
cdm updatecdm update は非対話でインストーラの処理を再実行するため、PATH の自動設定を抑止したい場合は環境変数 CDM_SKIP_PATH_SETUP=1 を利用してください。詳細は cdm update を参照してください。