コンテンツにスキップ

CLI クイックスタート

オープンソース CLI をインストールし、リポジトリを監査し、最初のレポートを確認します。


要件を確認する

  • Node.js 18 以降。
  • 公開された vice-security パッケージの npm。
  • ブラウザベースのリモートチェックのためのオプションの Chromium サポート。

CLI をインストールする

VICE を定期的に使用する場合はパッケージをグローバルにインストールするか、単独の最初の監査のために npx 経由で実行します。

グローバルインストール
1npm install -g vice-security
2vice --help

リポジトリを監査する

プロジェクト ルートからコマンドを実行すると、VICE はソース、パッケージ メタデータ、構成、移行、コンテナ、ワークフロー、Git 履歴をコンテキスト内で理解できるようになります。

現地監査
1cd your-project
2vice audit .

結果を確認する

  • 新しい重大な問題や検出数の多い問題から始めます。
  • コードを変更する前に、証拠とソースの場所を読んでください。
  • セキュリティ スコアに依存する前に、除外された検出された問題とカバレッジを確認してください。
  • 修正後に同じコマンドを再実行します。

レビュー後に CI しきい値を追加する

セキュリティ スコアがしきい値を下回る場合、CI モードは失敗した終了コードを返します。デフォルトの CI しきい値は 70 です。リポジトリに別のポリシーが必要な場合は、明示的な値を設定します。

CI セキュリティ セキュリティ スコアのしきい値
vice audit . --ci --min-score 80
Baseline 既存の作品を最初に
説明のつかない結果を baseline の後ろに隠さないでください。それをレビューし、決定を文書化し、必要に応じて既知の検出された問題のスナップショットを作成します。

VICE を続行する

オープンソース エンジン、モジュール、スコープ コントロールを確認します。

VICE エンジンを詳しく見る