You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst
+54Lines changed: 54 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -135,6 +135,60 @@ pack names and use the ``--download`` flag::
135
135
The ``analyze`` command above runs the default suite from ``microsoft/coding-standards v1.0.0`` and the latest version of ``github/security-queries`` on the specified database.
136
136
For further information about default suites, see ":ref:`Publishing and using CodeQL packs <publishing-and-using-codeql-packs>`".
137
137
138
+
Running a subset of queries in a CodeQL pack
139
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140
+
141
+
Additionally, you can include a path at the end of a pack specification to run a subset of queries inside the pack. This applies to any command that locates or runs queries within a pack.
142
+
143
+
The complete way to specify a set of queries is in the form ``scope/name@range:path``, where:
144
+
145
+
- ``scope/name`` is the qualified name of a CodeQL pack.
146
+
- ``range`` is a `semver range <https://docs.npmjs.com/cli/v6/using-npm/semver#ranges>`_.
147
+
- ``path`` is a file system path to a single query, a directory containing queries, or a query suite file.
148
+
149
+
If a ``scope/name`` is specified, the ``range`` and ``path`` are
150
+
optional. A missing ``range`` implies the latest version of the
151
+
specified pack. A missing ``path`` implies the default query suite
152
+
of the specified pack.
153
+
154
+
The ``path`` can be one of a ``*.ql`` query file, a directory
155
+
containing one or more queries, or a ``.qls`` query suite file. If
156
+
there is no pack name specified, then a ``path`` must be provided,
157
+
and will be interpreted relative to the current working directory
158
+
of the current process.
159
+
160
+
If a ``scope/name`` and ``path`` are specified, then the ``path`` cannot
161
+
be absolute. It is considered relative to the root of the CodeQL
0 commit comments