mirror of
https://github.com/github/codeql.git
synced 2026-04-25 00:35:20 +02:00
Merge pull request #15349 from github/remove-codeql-cli-docs
Remove outdated CodeQL CLI docs
This commit is contained in:
Aditya Sharad
@@ -1,25 +0,0 @@
|
||||
.. _about-codeql-packs:
|
||||
|
||||
About CodeQL packs
|
||||
==================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`About CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `CodeQL pack structure <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#codeql-pack-structure>`__
|
||||
* `About published packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-published-packs>`__
|
||||
* `About qlpack.yml files <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-qlpackyml-files>`__
|
||||
* `qlpack.yml properties <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#qlpackyml-properties>`__
|
||||
* `About codeql-pack.lock.yml files <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-codeql-packlockyml-files>`__
|
||||
* `Examples of custom CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#examples-of-custom-codeql-packs>`__
|
||||
* `CodeQL packs for custom libraries <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#codeql-packs-for-custom-libraries>`__
|
||||
* `CodeQL packs for custom queries <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#codeql-packs-for-custom-queries>`__
|
||||
* `CodeQL packs for custom tests <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#codeql-packs-for-custom-tests>`__
|
||||
* `Examples of CodeQL packs in the CodeQL repository <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#examples-of-codeql-packs-in-the-codeql-repository>`__
|
||||
* `Core library pack <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#core-library-pack>`__
|
||||
* `Core query pack <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#core-query-pack>`__
|
||||
* `Tests for the core CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#tests-for-the-core-codeql-pack>`__
|
||||
@@ -1,16 +0,0 @@
|
||||
.. _about-codeql-workspaces:
|
||||
|
||||
About CodeQL workspaces
|
||||
=======================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`About CodeQL workspaces <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `The codeql-workspace.yml file <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces#the-codeql-workspaceyml-file>`__
|
||||
* `Source dependencies <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces#source-dependencies>`__
|
||||
* `CodeQL workspaces and query resolution <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces#codeql-workspaces-and-query-resolution>`__
|
||||
* `Example <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces#example>`__
|
||||
@@ -1,14 +0,0 @@
|
||||
.. _about-ql-packs:
|
||||
|
||||
About QL packs
|
||||
==============
|
||||
|
||||
.. pull-quote::
|
||||
This page was moved to "`About CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
about-ql-packs
|
||||
@@ -1,13 +0,0 @@
|
||||
.. _about-the-codeql-cli:
|
||||
|
||||
About the CodeQL CLI
|
||||
====================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`About the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `CodeQL CLI commands <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/about-the-codeql-cli#codeql-cli-commands>`__
|
||||
@@ -1,25 +0,0 @@
|
||||
.. _analyzing-databases-with-the-codeql-cli:
|
||||
|
||||
Analyzing databases with the CodeQL CLI
|
||||
=======================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Analyzing databases with the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Running codeql database analyze <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-codeql-database-analyze>`__
|
||||
* `Specifying which queries to run in a CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#specifying-which-queries-to-run-in-a-codeql-pack>`__
|
||||
* `Example query specifiers <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#example-query-specifiers>`__
|
||||
* `Examples of running database analyses <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#examples-of-running-database-analyses>`__
|
||||
* `Running a CodeQL query pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-a-codeql-query-pack>`__
|
||||
* `Running a single query <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-a-single-query>`__
|
||||
* `Running all queries in a directory <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-all-queries-in-a-directory>`__
|
||||
* `Running a subset of queries in a CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-a-subset-of-queries-in-a-codeql-pack>`__
|
||||
* `Running query suites <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#running-query-suites>`__
|
||||
* `Diagnostic and summary information <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#diagnostic-and-summary-information>`__
|
||||
* `Integrating a CodeQL pack into a code scanning workflow in GitHub <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#integrating-a-codeql-pack-into-a-code-scanning-workflow-in-github>`__
|
||||
* `Including query help for custom CodeQL queries in SARIF files <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#including-query-help-for-custom-codeql-queries-in-sarif-files>`__
|
||||
* `Results <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli#results>`__
|
||||
@@ -1,22 +0,0 @@
|
||||
.. _codeql-cli-reference:
|
||||
|
||||
:orphan:
|
||||
|
||||
CodeQL CLI reference
|
||||
====================
|
||||
|
||||
.. pull-quote::
|
||||
This category was moved to "`CodeQL CLI reference <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
about-codeql-packs
|
||||
about-codeql-workspaces
|
||||
query-reference-files
|
||||
sarif-output
|
||||
exit-codes
|
||||
extractor-options
|
||||
@@ -1,17 +0,0 @@
|
||||
.. _creating-and-working-with-codeql-packs:
|
||||
|
||||
Creating and working with CodeQL packs
|
||||
======================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Creating and working with CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `About CodeQL packs and the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs#about-codeql-packs-and-the-codeql-cli>`__
|
||||
* `Creating a CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs#creating-a-codeql-pack>`__
|
||||
* `Modifying an existing legacy QL pack to create a CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs#modifying-an-existing-legacy-ql-pack-to-create-a-codeql-pack>`__
|
||||
* `Adding and installing dependencies to a CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs#adding-and-installing-dependencies-to-a-codeql-pack>`__
|
||||
* `Customizing a downloaded CodeQL pack <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs#customizing-a-downloaded-codeql-pack>`__
|
||||
@@ -1,24 +0,0 @@
|
||||
.. _creating-codeql-databases:
|
||||
|
||||
Creating CodeQL databases
|
||||
=========================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Creating CodeQL databases <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Running codeql database create <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#running-codeql-database-create>`__
|
||||
* `Progress and results <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#progress-and-results>`__
|
||||
* `Creating databases for non-compiled languages <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#creating-databases-for-non-compiled-languages>`__
|
||||
* `JavaScript and TypeScript <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#javascript-and-typescript>`__
|
||||
* `Python <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#python>`__
|
||||
* `Ruby <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#ruby>`__
|
||||
* `Creating databases for compiled languages <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#creating-databases-for-compiled-languages>`__
|
||||
* `Detecting the build system <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#detecting-the-build-system>`__
|
||||
* `Specifying build commands <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#specifying-build-commands>`__
|
||||
* `Using indirect build tracing <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#using-indirect-build-tracing>`__
|
||||
* `Example of creating a CodeQL database using indirect build tracing <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#example-of-creating-a-codeql-database-using-indirect-build-tracing>`__
|
||||
* `Downloading databases from GitHub.com <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#downloading-databases-from-githubcom>`__
|
||||
@@ -1,21 +0,0 @@
|
||||
.. _creating-codeql-query-suites:
|
||||
|
||||
Creating CodeQL query suites
|
||||
============================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Creating CodeQL query suites <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Locating queries to add to a query suite <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#locating-queries-to-add-to-a-query-suite>`__
|
||||
* `Filtering the queries in a query suite <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#filtering-the-queries-in-a-query-suite>`__
|
||||
* `Examples of filtering which queries are run <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#examples-of-filtering-which-queries-are-run>`__
|
||||
* `Reusing existing query suite definitions <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#reusing-existing-query-suite-definitions>`__
|
||||
* `Reusability Examples <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#reusability-examples>`__
|
||||
* `Naming a query suite <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#naming-a-query-suite>`__
|
||||
* `Saving a query suite <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#saving-a-query-suite>`__
|
||||
* `Specifying well-known query suites <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#specifying-well-known-query-suites>`__
|
||||
* `Using query suites with CodeQL <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites#using-query-suites-with-codeql>`__
|
||||
@@ -1,9 +0,0 @@
|
||||
.. _exit-codes:
|
||||
|
||||
Exit codes
|
||||
==========
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Exit codes <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/exit-codes>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
@@ -1,15 +0,0 @@
|
||||
.. extractor-options:
|
||||
|
||||
Extractor options
|
||||
=================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Extractor options <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/extractor-options>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `About extractor options <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/extractor-options#about-extractor-options>`__
|
||||
* `Setting extractor options with the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/extractor-options#setting-extractor-options-with-the-codeql-cli>`__
|
||||
* `Setting extractor options from files <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/extractor-options#setting-extractor-options-from-files>`__
|
||||
@@ -1,25 +0,0 @@
|
||||
.. _getting-started-with-the-codeql-cli:
|
||||
|
||||
Getting started with the CodeQL CLI
|
||||
===================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Getting started with the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Setting up the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#setting-up-the-codeql-cli>`__
|
||||
* `1. Download the CodeQL CLI zip package <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#1-download-the-codeql-cli-zip-package>`__
|
||||
* `2. Extract the zip archive <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#2-extract-the-zip-archive>`__
|
||||
* `3. Launch codeql <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#3-launch-codeql>`__
|
||||
* `4. Verify your CodeQL CLI setup <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#4-verify-your-codeql-cli-setup>`__
|
||||
* `Checking out the CodeQL source code directly <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#checking-out-the-codeql-source-code-directly>`__
|
||||
* `1. Download the CodeQL CLI zip <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#1-download-the-codeql-cli-zip>`__
|
||||
* `2. Create a new CodeQL directory <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#2-create-a-new-codeql-directory>`__
|
||||
* `3. Obtain a local copy of the CodeQL queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#3-obtain-a-local-copy-of-the-codeql-queries>`__
|
||||
* `4. Extract the zip archive <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#4-extract-the-zip-archive>`__
|
||||
* `5. Launch codeql <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#5-launch-codeql>`__
|
||||
* `6. Verify your CodeQL CLI setup <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#6-verify-your-codeql-cli-setup>`__
|
||||
* `Using two versions of the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli#using-two-versions-of-the-codeql-cli>`__
|
||||
@@ -1,18 +0,0 @@
|
||||
.. _codeql-cli:
|
||||
|
||||
CodeQL CLI
|
||||
==========
|
||||
|
||||
.. include:: ../reusables/codeql-cli-overview.rst
|
||||
|
||||
- `Using the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli>`__: Software
|
||||
developers and security researchers can secure their code using the CodeQL CLI.
|
||||
|
||||
- `CodeQL CLI reference <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference>`__: Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates.
|
||||
|
||||
- `CodeQL CLI manual <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
.. _publishing-and-using-codeql-packs:
|
||||
|
||||
Publishing and using CodeQL packs
|
||||
=================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Publishing and using CodeQL packs <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Configuring the qlpack.yml file before publishing <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#configuring-the-qlpackyml-file-before-publishing>`__
|
||||
* `Running codeql pack publish <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#running-codeql-pack-publish>`__
|
||||
* `Running codeql pack download <scope>/<pack> <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#running-codeql-pack-download-scopepack>`__
|
||||
* `Using a CodeQL pack to analyze a CodeQL database <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#using-a-codeql-pack-to-analyze-a-codeql-database>`__
|
||||
* `About CodeQL pack compatibility <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#about-codeql-pack-compatibility>`__
|
||||
* `Working with CodeQL packs on GitHub Enterprise Server <https://docs.github.com/en/enterprise-server@3.7/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#working-with-codeql-packs-on-github-enterprise-server>`__
|
||||
* `Authenticating to GitHub Container registries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs#authenticating-to-github-container-registries>`__
|
||||
@@ -1,14 +0,0 @@
|
||||
.. _query-reference-files:
|
||||
|
||||
Query reference files
|
||||
=====================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Query reference files <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/query-reference-files>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Defining a query reference file <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/query-reference-files#defining-a-query-reference-file>`__
|
||||
* `Example <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/query-reference-files#example>`__
|
||||
@@ -1,31 +0,0 @@
|
||||
.. _sarif-output:
|
||||
|
||||
SARIF output
|
||||
============
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`CodeQL CLI SARIF output <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `SARIF specification and schema <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#sarif-specification-and-schema>`__
|
||||
* `Change notes <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#change-notes>`__
|
||||
* `Changes between versions <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#changes-between-versions>`__
|
||||
* `Future changes to the output <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#future-changes-to-the-output>`__
|
||||
* `Generated SARIF objects <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#generated-sarif-objects>`__
|
||||
* `sarifLog object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#sariflog-object>`__
|
||||
* `run object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#run-object>`__
|
||||
* `tool object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#tool-object>`__
|
||||
* `toolComponent object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#toolcomponent-object>`__
|
||||
* `reportingDescriptor object for rule <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#reportingdescriptor-object-for-rule>`__
|
||||
* `artifact object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#artifact-object>`__
|
||||
* `artifactLocation object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#artifactlocation-object>`__
|
||||
* `result object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#result-object>`__
|
||||
* `location object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#location-object>`__
|
||||
* `physicalLocation object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#physicallocation-object>`__
|
||||
* `region object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#region-object>`__
|
||||
* `codeFlow object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#codeflow-object>`__
|
||||
* `threadFlow object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#threadflow-object>`__
|
||||
* `threadFlowLocation object <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-reference/sarif-output#threadflowlocation-object>`__
|
||||
@@ -1,14 +0,0 @@
|
||||
.. _specifying-command-options-in-a-codeql-configuration-file:
|
||||
|
||||
Specifying command options in a CodeQL configuration file
|
||||
=========================================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Specifying command options in a CodeQL configuration file <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Using a CodeQL configuration file <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file#using-a-codeql-configuration-file>`__
|
||||
* `Examples <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file#examples>`__
|
||||
@@ -1,19 +0,0 @@
|
||||
.. _testing-custom-queries:
|
||||
|
||||
Testing custom queries
|
||||
======================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Testing custom queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Setting up a test CodeQL pack for custom queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#setting-up-a-test-codeql-pack-for-custom-queries>`__
|
||||
* `Setting up the test files for a query <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#setting-up-the-test-files-for-a-query>`__
|
||||
* `Running codeql test run <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#running-codeql-test-run>`__
|
||||
* `Example <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#example>`__
|
||||
* `Prepare a query and test files <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#prepare-a-query-and-test-files>`__
|
||||
* `Execute the test <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#execute-the-test>`__
|
||||
* `View the query test output <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries#view-the-query-test-output>`__
|
||||
@@ -1,15 +0,0 @@
|
||||
.. _testing-query-help-files:
|
||||
|
||||
Testing query help files
|
||||
========================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Testing query help files <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Prerequisites <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files#prerequisites>`__
|
||||
* `Running codeql generate query-help <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files#running-codeql-generate-query-help>`__
|
||||
* `Results <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files#results>`__
|
||||
@@ -1,16 +0,0 @@
|
||||
.. _using-custom-queries-with-the-codeql-cli:
|
||||
|
||||
Using custom queries with the CodeQL CLI
|
||||
=========================================
|
||||
|
||||
.. pull-quote::
|
||||
This article was moved to "`Using custom queries with the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. include:: ../reusables/codeql-cli-migration-toc-note.rst
|
||||
|
||||
* `Writing a valid query <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#writing-a-valid-query>`__
|
||||
* `Including query metadata <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-metadata>`__
|
||||
* `Packaging custom QL queries <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#packaging-custom-ql-queries>`__
|
||||
* `Contributing to the CodeQL repository <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#contributing-to-the-codeql-repository>`__
|
||||
@@ -1,28 +0,0 @@
|
||||
.. _using-the-codeql-cli:
|
||||
|
||||
:orphan:
|
||||
|
||||
Using the CodeQL CLI
|
||||
====================
|
||||
|
||||
.. pull-quote::
|
||||
This category was moved to "`Using the CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli>`__" on the `GitHub Docs <https://docs.github.com/en/code-security/codeql-cli>`__ site as of January 2023.
|
||||
|
||||
.. include:: ../reusables/codeql-cli-articles-migration-note.rst
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
about-the-codeql-cli
|
||||
getting-started-with-the-codeql-cli
|
||||
creating-codeql-databases
|
||||
extractor-options
|
||||
analyzing-databases-with-the-codeql-cli
|
||||
using-custom-queries-with-the-codeql-cli
|
||||
creating-codeql-query-suites
|
||||
testing-custom-queries
|
||||
testing-query-help-files
|
||||
creating-and-working-with-codeql-packs
|
||||
publishing-and-using-codeql-packs
|
||||
Specifying command options <specifying-command-options-in-a-codeql-configuration-file>
|
||||
@@ -4,11 +4,9 @@ CodeQL documentation
|
||||
.. toctree::
|
||||
:includehidden:
|
||||
:maxdepth: 3
|
||||
|
||||
|
||||
codeql-overview/index
|
||||
codeql-for-visual-studio-code/index
|
||||
codeql-cli/index
|
||||
writing-codeql-queries/index
|
||||
codeql-language-guides/index
|
||||
ql-language-reference/index
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
CodeQL tools
|
||||
</div>
|
||||
<li><a class="dropdown-item" href="codeql-for-visual-studio-code">CodeQL for VS Code</a>
|
||||
<li><a class="dropdown-item" href="codeql-cli">CodeQL CLI</a>
|
||||
<li><a class="dropdown-item" href="https://docs.github.com/en/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli">CodeQL CLI</a>
|
||||
</li>
|
||||
<li class="dropdown-divider" role="separator"></li>
|
||||
<div class="dropdown-header">
|
||||
@@ -122,7 +122,7 @@
|
||||
</div>
|
||||
<div class="Box-body border-bottom-0">
|
||||
<div class="Subhead border-0">
|
||||
<a href="codeql-cli">
|
||||
<a href="https://docs.github.com/en/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli">
|
||||
<div class="Subhead-heading f4 text-center">CodeQL CLI</div>
|
||||
</a>
|
||||
<div class="Subhead-description border-bottom-0">The CodeQL command-line interface (CLI) is used
|
||||
@@ -138,7 +138,7 @@
|
||||
</div>
|
||||
<div class="Subhead border-0">
|
||||
<a
|
||||
href="https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning">
|
||||
href="https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning">
|
||||
<div class="Subhead-heading f4 text-center">Code scanning with CodeQL</div>
|
||||
</a>
|
||||
<div class="Subhead-description">Use code scanning with CodeQL to analyze the code in a GitHub
|
||||
@@ -356,7 +356,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="list-style-none d-flex text-gray">
|
||||
<li class="mr-3">©
|
||||
<li class="mr-3">©
|
||||
<script type="text/javascript">document.write(new Date().getFullYear());</script> GitHub, Inc.</li>
|
||||
<li class="mr-3"><a
|
||||
href="https://docs.github.com/github/site-policy/github-terms-of-service"
|
||||
@@ -369,4 +369,4 @@
|
||||
</div>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user