3. Spotter CLIのインストール

「steampunk-spotter」は、Python パッケージとして提供されています。※インストールするには Python 3 以上が必要です。

$ pip install steampunk-spotter

CLI を起動して実行したら、コマンドとオプションの引数を簡単に確認できます。以下ヘルプコマンドにて、必要な情報をすべて参照することが可能です。

$ spotter –help

また全てのコマンドに「--help」または「-h」オプションを以下のように利用できます。

$ spotter <対象コマンド> –help/-h

認証

CLI を使用する場合は、まず、APIエンドポイントを設定する必要があります。設定方法は複数あります。

1. SPOTTER_ENDPOINT環境変数の設定する

$ export SPOTTER_ENDPOINT=<spotter-api-url>

※パブリッククラウドを利用する場合：

$ export SPOTTER_ENDPOINT=https://app.steampunk-spotter.jp/api

2. ストレージフォルダ（~/.config/steampunk-spotter/spotter.json）に、ルートJSONエントリ "endpoint": "<endpoint>" と記載した設定ファイルを作成する：

選択したAPIエンドポイントは一定のままです。パブリッククラウドを利用する場合は、以下のJSONコンテンツを手動で作成します：

{

"endpoint" : "https://app.steampunk-spotter.jp/api"

}

続いて認証を行います。設定方法は複数あります。

1. ユーザー名とパスワード:

$ spotter --username <username> --password <password> scan playbook.yml

2. APIトークン:

トークンを作成および管理するには、 Steampunk Spotter アプリにアクセスし、右上のアカウントメニューを開いて [My settings] をクリックし、[API tokens] タブに切り替えます。
$ spotter --token <api-token> scan playbook.yml
ヒント
Spotter CLI を使用するたびに資格情報を入力しなくて済むようにするには、spotter login コマンドを使用します。
資格情報は、ログアウトするまでプロファイルに保存されます。
$ spotter --token <api-token> login

CLI から直接 Spotter ユーザーアカウントからログアウトする場合は、spotter logoutコマンドを使用するだけです。
これにより、現在使用している Spotter API の認証トークンが削除されます。
これらのトークンは通常以下のフォルダーに保存されます。
~/.config/steampunk-spotter

これで完了です。スキャンを開始できます。