hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-01 07:42:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to reflect changes to database analyze

Browse Source
This commit is contained in:
Edoardo Pirovano
2021-09-21 10:16:12 +01:00
parent 4adb0c75bd
commit 5a28a796af
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst
View File

@@ -33,18 +33,12 @@ When you run ``database analyze``, it:
You can analyze a database by running the following command::
codeql database analyze <database> <queries> --format=<format> --output=<output>
codeql database analyze <database> --format=<format> --output=<output> <queries>
You must specify:
- ``<database>``: the path to the CodeQL database you want to analyze.
- ``<queries>``: the queries to run over your database. You can
list one or more individual query files, specify a directory that will be
searched recursively for query files, or name a query suite that defines a
particular set of queries. For more information, see the :ref:`examples
<database-analyze-examples>` below.
- ``--format``: the format of the results file generated during analysis. A
number of different formats are supported, including CSV, :ref:`SARIF
<sarif-file>`, and graph formats. For more information about CSV and SARIF,
@@ -56,6 +50,13 @@ You must specify:
You can also specify:
- ``<queries>``: the queries to run over your database. You can
list one or more individual query files, specify a directory that will be
searched recursively for query files, or name a query suite that defines a
particular set of queries. If omitted, the default query suite for the language
of the database being analyzed will be usedFor more information, see the
:ref:`examples <database-analyze-examples>` below.
- ``--sarif-category``: an identifying category for the results. Used when
you want to upload more than one set of results for a commit.
For example, when you use ``github upload-results`` to send results for more than one