3. Spotter CLIのインストール

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

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

    • Related Articles

    • 15. Spotter コマンド集

      こちらの記事でSpotterコマンド全件を紹介します。 Spotter CLIで「--help」コマンドを実行することでも、いつでも確認することが可能です。 スキャン $ spotter scan playbook.yml デフォルトスキャンを実行します。 $ spotter scan path/to/playbook プレイブックをスキャンします。 $ spotter scan path/to/taskfile1.yaml タスクファイルをスキャンします。 $ spotter scan ...

    • Steampunk Spotter オンプレミスのインストール

      オンプレミスのインストール方法 まずは、インストーラーをダウンロードします。接続が切断された場合でもダウンロードが自動的に再開されるため、wgetコマンドを使用することをお勧めします。 ※インストーラーのURLはご利用開始時にご案内します。 wget -O spotter.run https://cdn.spotter.steampunk.si/public/<installer>.run ...

    • 12. Playbook作成支援

      Spotter Assisted Writing 機能により、プレイブックの作成がさらにスピードアップします。 自動化の目標を定義するだけで、Spotter が適切なタスクや、可能な場合はプレイブック全体を提案します。 この機能は Spotter VSC 拡張機能でのみ使用できることに注意してください 。VSC 拡張機能の詳細については 、 「16.インテグレーション」を参照してください。 インライン提案を取得 ...

    • 16. インテグレーション

      Spotter の機能を強化し、ワークフローを合理化し、開発プロジェクトを効率的に管理します。Spotter は作業環境とシームレスに統合されます。 GitLab と GitHub の統合により CI/CD パイプラインに組み込んだり、Spotter Visual Studio Code 拡張機能を使用してお気に入りのコード エディターで使用したり、 追加の機能を発見したりすることもできます。 GitHubアクション Steampunk Spotter GitHub Action ...

    • 2. アカウント作成

      Steampunk Spotter アカウントは体験版をお申し込みいただいた後ご案内いたします。 体験版について、弊社営業担当までお問い合わせください。