Skip to main content

Visual Studio Code 向け CodeQL のインストール

CodeQLのVisual Studio Codeの使用を開始するには、拡張機能をインストールして設定する必要があります。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

  • GitHub.com のパブリック リポジトリについては、「GitHub CodeQL の使用条件」を参照してください
  • GitHub Team が有効になっている GitHub Code Security 上の organization 所有のリポジトリ

前提条件

CodeQL拡張機能には、Visual Studio Code 1.82.0 以上が必要です。 以前のバージョンはサポートされていません。

拡張機能をインストールする

CodeQLはVisual Studio Code拡張機能として、いずれかの方法を使ってインストールできます。

  • ブラウザーで Visual Studio Code Marketplace を使用する。

  • Visual Studio Codeの [拡張機能] ビューで検索します。

  • VSIX ファイルを使用する。

Visual Studio Code Marketplace の使用

  1. ブラウザーで、Marketplace の "" ページにアクセスしてください。

  2. [インストール] をクリックし、画面上の指示に従います。

[拡張機能] ビューでの検索

  1. VS Codeで、[拡張機能] ビューを開きます。

  2. "CodeQL" を検索し、[ インストール] をクリックします。

CodeQL VSIX ファイルの使用

  1. CodeQLの リポジトリからgithub/vscode-codeqlGitHubをダウンロードします。

  2. VS Codeで、[拡張機能] ビューを開きます。

  3. サイドバーの右上にある省略記号をクリックし、[VSIX からインストール...] をクリックします。

  4. 手順 1 でダウンロードした CodeQL VSIX ファイルを選択します。

  5. 画面上に表示される指示に従って、インストールを完了します。

次のステップ

拡張機能で CodeQL データベースを操作する方法については、 CodeQL データベースの管理 を参照してください。

CodeQL データベースを既に検出、ダウンロード、または作成している場合は、拡張機能を使用して、CodeQL データベースに対してクエリを実行し、結果を表示する方法を学習できます。 詳細については、「CodeQL クエリの実行」を参照してください。

コードベースの追加の依存関係をモデル化し、 code scanning の結果を改善する方法については、 CodeQL モデル エディターの使用 を参照してください。

拡張機能と共にインストールされているバージョンとは異なるバージョンの CodeQL CLI へのアクセスを構成する方法については、 VS Code 拡張機能での CodeQL CLI の管理 を参照してください。

CodeQL ワークスペースを設定する方法については、「CodeQL ワークスペースのセットアップ」を参照してください。