CodeQL CLI について

注: この記事は、2023 年 1 月に CodeQL ドキュメント Web サイトから移行されました。

ソフトウェア開発者とセキュリティ研究者は、CodeQL CLI を使ってコードをセキュリティ保護できます。

CodeQL CLI は、オープンソースソフトウェアプロジェクトでローカルに CodeQL プロセスを実行するために使われるコマンドラインツールです。 CodeQL CLI を使って次のことができます。

CodeQL CLI の使用については、「CodeQL CLI の概要」をご覧ください。

GitHub CodeQL のライセンスについて

ライセンスに関する注意: GitHub Enterprise ライセンスをお持ちでない場合は、この製品をインストールすることで、GitHub CodeQL の使用条件に同意したことになります。

GitHub CodeQL のライセンスは、ユーザーごとに付与されます。ライセンスの制限の下で、CodeQL を使って次のタスクを実行できます。

学術研究を行う。
ソフトウェアのデモを行う。
OSI 承認済みライセンスの下でリリースされた CodeQL クエリをテストし、それらのクエリの新しいバージョンで引き続き適切な脆弱性が検出されることを確認する。

"OSI 承認済みライセンス" とは、オープンソースイニシアティブ (OSI) が承認したオープンソースソフトウェアライセンスを意味します。

オープンソースコードベース (つまり、OSI 承認済みライセンスの下でリリースされたコードベース) を使用している場合は、次のタスクに CodeQL を使うこともできます。

オープンソースコードベースの分析を実行する。
オープンソースコードベースが GitHub.com でホストおよび保守されている場合、自動分析、継続的インテグレーション、または継続的デリバリーのために、またはそれらの間に、CodeQL データベースを生成する。

ここに記載されている場合を除き、通常のソフトウェアエンジニアリングプロセスの一部であるかどうかにかかわらず、自動分析、継続的インテグレーション、または継続的デリバリーに CodeQL を使うことはできません。これらの用途については、営業チームにお問い合わせください。

CodeQL CLI には、コマンドラインから CodeQL データベースを作成および分析するためのコマンドが含まれています。コマンドを実行するには、次の構文を使います。

codeql [command] [subcommand]

コマンドのリファレンスドキュメントを表示するには、--help フラグを追加するか、「CodeQL CLI マニュアル」をご覧ください。