Cloud Automator CLI

Cloud Automator CLI (ca) は、Cloud Automator のトリガージョブと後処理の情報をエクスポート・インポートするためのコマンドラインツールです。

• Cloud Automator

インストール

Linux/macOS

1. インストールスクリプトを実行する

インストールスクリプトは ~/.local/bin, ~/bin, /usr/local/bin の順番で書き込み可能なディレクトリを探して、最初に見つかったディレクトリにインストールします。

curl -sSf https://raw.githubusercontent.com/CloudAutomator/cli/main/install.sh | sh -s

Note

インストール先を指定したい場合は BINDIR 環境変数を設定して実行してください。

curl -sSf https://raw.githubusercontent.com/CloudAutomator/cli/main/install.sh | BINDIR=~/.cloudautomator/bin sh -s

2. Cloud Automator CLI が正しくインストールされたことを確認する

ca version

command not found と表示される場合、インストール先のディレクトリが PATH に含まれているかを確認してください。

Windows

1. Releases から、Windows のZIPパッケージをダウンロードします
2. ダウンロードしたパッケージを解凍します
3. スタートメニューを開いて「環境変数」を検索、「システム環境変数の編集」をクリックします
4. 「環境変数」ボタンをクリックします
5. 「<ユーザー名> のユーザー環境変数」ボックス内の Path をクリックして選択、「編集」ボタンをクリックします
6. 「新規」ボタンをクリック、(2) で解凍したフォルダのパスを指定します
7. PowerShell、もしくはコマンドプロンプトで Cloud Automator CLI が正しくインストールされたことを確認します

ca version

使用方法

環境変数の設定

Cloud Automator CLI を利用するには、APIキーを環境変数に設定する必要があります。 APIキーの取得方法については、以下のサービスマニュアルを参照してください。

• Cloud Automator APIの利用方法

Linux/macOS

export CLOUDAUTOMATOR_API_KEY="APIキー"

Windows

Command Prompt

set CLOUDAUTOMATOR_API_KEY=APIキー

PowerShell

$Env:CLOUDAUTOMATOR_API_KEY="APIキー"

ジョブの情報をエクスポートする

すべてのジョブの情報をエクスポートする。

ca jobs export

IDを指定してジョブをエクスポートする。

ca jobs export --id <job_id>

オプション

--output, -o

エクスポートした結果の出力形式を指定する。

# 例: YAML形式で出力する
ca jobs export --id 1234 --output yaml

# 例: JSON形式で出力する
ca jobs export --id 1234 --output json

後処理の情報をエクスポートする

すべての後処理の情報をエクスポートする

ca post-processes export

IDを指定して後処理の情報をエクスポートする

ca post-processes export --id <post-process-id>

オプション

--output, -o

エクスポートした結果の出力形式を指定する。

# 例: YAML形式で出力する
ca post-processes export --id 1234 --output yaml

# 例: JSON形式で出力する
ca post-processes export --id 1234 --output json

ジョブをインポートする

ファイルを指定してジョブをインポートする

ca jobs import <filepath>

後処理をインポートする

ファイルを指定して後処理をインポートする

ca post-processes import <filepath>

ジョブのインポート結果を確認する

全てのジョブのインポート結果を確認する

ca jobs import-results

IDを指定してジョブのインポート結果を確認する

ca jobs import-results --id <import-id>

後処理のインポート結果を確認する

全ての後処理のインポート結果を確認する

ca post-processes import-results

IDを指定して後処理のインポート結果を確認する

ca post-processes import-results --id <import-id>

アップデート

インストールの手順と同様に、インストールスクリプトを実行してください。
最新のバージョンのバイナリがダウンロードされ、古いバージョンのバイナリが上書きされます。

アンインストール

バイナリを削除することでアンインストールできます。

Linux/macOS

# バイナリがインストールされているディレクトリを確認する
which ca
~/.local/bin/ca

# バイナリを削除する
rm ~/.local/bin/ca

Windows

# バイナリがインストールされているディレクトリを確認する
where ca
C:\Users\<ユーザー名>\AppData\Local\Programs\ca\ca.exe

# バイナリを削除する
del C:\Users\<ユーザー名>\AppData\Local\Programs\ca\ca.exe