Skip to content

Commit b960857

Browse files
Merge pull request #6722 from edoardopirovano/update-analyze-docs
Update documentation to reflect changes to `database analyze`
2 parents 65d3373 + 5a28a79 commit b960857

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,12 @@ When you run ``database analyze``, it:
3333

3434
You can analyze a database by running the following command::
3535

36-
codeql database analyze <database> <queries> --format=<format> --output=<output>
36+
codeql database analyze <database> --format=<format> --output=<output> <queries>
3737

3838
You must specify:
3939

4040
- ``<database>``: the path to the CodeQL database you want to analyze.
4141

42-
- ``<queries>``: the queries to run over your database. You can
43-
list one or more individual query files, specify a directory that will be
44-
searched recursively for query files, or name a query suite that defines a
45-
particular set of queries. For more information, see the :ref:`examples
46-
<database-analyze-examples>` below.
47-
4842
- ``--format``: the format of the results file generated during analysis. A
4943
number of different formats are supported, including CSV, :ref:`SARIF
5044
<sarif-file>`, and graph formats. For more information about CSV and SARIF,
@@ -56,6 +50,13 @@ You must specify:
5650

5751
You can also specify:
5852

53+
- ``<queries>``: the queries to run over your database. You can
54+
list one or more individual query files, specify a directory that will be
55+
searched recursively for query files, or name a query suite that defines a
56+
particular set of queries. If omitted, the default query suite for the language
57+
of the database being analyzed will be usedFor more information, see the
58+
:ref:`examples <database-analyze-examples>` below.
59+
5960
- ``--sarif-category``: an identifying category for the results. Used when
6061
you want to upload more than one set of results for a commit.
6162
For example, when you use ``github upload-results`` to send results for more than one

0 commit comments

Comments
 (0)