Contrast CLIのインストール

Contrast CLIをインストールするには：

  1. Node.jsをインストールします。Contrast CLIはNode.jsパッケージとして実行されるため、これは必須です。現在、バージョンは10、12および14をサポートします。

  2. 検査対象のアプリケーションにContrastエージェントを組み込んで起動します。これによって、Contrast CLIで参照するためのアプリケーションIDを取得できます。

    注記

    まだエージェントが組み込まれていないアプリケーションも、Contrast CLIで登録することができます。ただし、アプリケーションのライブラリスコアを評価して、ライブラリ一覧を作成するには、エージェントを組み込んでアプリケーションを起動する必要があります。

  3. プロキシ経由でContrastと通信を行うには、エージェントの設定でcli_proxyプロパティを使用してください。

    認証が必要な場合は、ユーザ名とパスワード、プロトコル、ホスト、ポートを以下の例のように指定します。例：

    http://username:password@<host>:<port>

  4. Contrast CLIで解析を行うには、対象アプリケーションのソースコードがローカルで利用できる必要があります。アプリケーション言語に応じて、以下の要件に従ってください。

    • Java： pom.xml ファイルが存在し、 dependencyプラグインを含めて Mavenがインストールされている必要があります。 Gradleプロジェクトでバージョン4.8以上の場合、 build.gradleファイルで依存関係ツリーを構築する前にgradle-wrapper.propertiesファイルが必要です。

      • [en] Maven: A Maven project must be defined with a pom.xml file, and have the Apache Maven Dependency plugin. To test if the CLI works with your project, build a dependency tree by running mvn dependency:tree.

      • [en] Gradle (v4.8 or above): To test if the CLI works with your project, build a dependency tree by running the Gradle dependencies task by running gradle dependencies or ./gradlew dependencies if using the Gradle Wrapper.

    • Node.js：package-lock.jsonまたは.yarn.lockファイルのいずれかが必要です。

    • Python：pipfileファイルおよびpipfile.lockファイルが必要です。

    • Ruby：gemfileファイルおよびgemfile.lockファイルが必要です。

    • Go(ベータ)：go.modファイルが必要です。

    注記

    現時点では、アプリケーションの言語は単一言語でのみのサポートです。

  5. 以下のコマンドを実行して、Contrast CLIをインストールします。

    npm install -g @contrast/contrast-cli

    または、以下のコマンドでyarnを使用してContrast CLIをインストールすることもできます。

    yarn global add @contrast/contrast-cli

    注記

    Contrast CLIのインストールは、グローバルインストールで行う必要があります。

  6. Contrast CLIのインストールが完了したら、アプリケーションを登録して、コードの解析を始めることができます。

: