jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 19:34:15 -05:00
Code Issues Projects Releases Wiki Activity

Update CodeQL CLI manual (#39456)

Browse Source 
Co-authored-by: Felicity Chapman <felicitymay@github.com>
This commit is contained in:
docs-bot
2023-07-27 06:25:16 -07:00
committed by GitHub
parent 06badea99b
commit 8c3679fbc7
37 changed files with 215 additions and 135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md
View File

@@ -1,6 +1,6 @@
---
title: bqrs info
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -56,7 +56,7 @@ Select output format, either `text` _(default)_ or `json`.
\[Advanced] When given together with `--format=json`, compute a table
of byte offsets that can later be given to the `--start-at` option of
[codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode), to start streaming results at positions 0, *\<num>*, 2\**\<num>*, and so
[codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode), to start streaming results at positions `0, <num>, 2*<num>` and so
forth.
#### `--paginate-result-set=<name>`

8
content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md
View File

@@ -1,6 +1,6 @@
---
title: database analyze
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -277,7 +277,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`
@@ -414,8 +414,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

24
content/code-security/codeql-cli/codeql-cli-manual/database-create.md
View File

@@ -1,6 +1,6 @@
---
title: database create
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -61,8 +61,8 @@ as it may recursively delete the entire database directory.
\[Advanced] Read a Code Scanning configuration file specifying options
on how to create the CodeQL databases and what queries to run in later
steps. For more details on the format of this configuration file, refer
to [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning). To run queries from this file in a
later step, invoke [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) without any other queries specified.
to [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning). To run queries from
this file in a later step, invoke [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) without any other queries specified.
#### `--[no-]db-cluster`
@@ -86,14 +86,6 @@ analyse. Note that to be able to do this, a GitHub PAT token must be
supplied either in the environment variable GITHUB\_TOKEN or via standard
input using the `--github-auth-stdin` option.
#### `--[no-]calculate-baseline`
\[Advanced] Calculate baseline information about the code being
analyzed and add it to the database. By default, this is enabled unless
the source root is the root of a filesystem. This flag can be used to
either disable, or force the behavior to be enabled even in the root of
the filesystem.
#### `-s, --source-root=<dir>`
\[Default: .] The root source code directory. In many cases, this will
@@ -145,6 +137,16 @@ extractor.
because no source code was seen during the build. The empty database
will be left unfinalized.
### Baseline calculation options
#### `--[no-]calculate-baseline`
\[Advanced] Calculate baseline information about the code being
analyzed and add it to the database. By default, this is enabled unless
the source root is the root of a filesystem. This flag can be used to
either disable, or force the behavior to be enabled even in the root of
the filesystem.
### Extractor selection options
#### `--search-path=<dir>[:<dir>...]`

8
content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md
View File

@@ -1,6 +1,6 @@
---
title: database index-files
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -41,11 +41,11 @@ The `--include`, `--exclude`, and `--prune` options all take glob
patterns, which can use the following wildcard characters:
- A single "?" matches any character other than a forward/backward
slash;
slash;
- A single "\*" matches any number of characters other than a
forward/backward slash;
forward/backward slash;
- The pattern "\*\*" matches zero or more complete directory
components.
components.
## Primary options

26
content/code-security/codeql-cli/codeql-cli-manual/database-init.md
View File

@@ -1,6 +1,6 @@
---
title: database init
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -74,8 +74,8 @@ as it may recursively delete the entire database directory.
\[Advanced] Read a Code Scanning configuration file specifying options
on how to create the CodeQL databases and what queries to run in later
steps. For more details on the format of this configuration file, refer
to [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning). To run queries from this file in a
later step, invoke [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) without any other queries specified.
to [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning). To run queries from
this file in a later step, invoke [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) without any other queries specified.
#### `--[no-]db-cluster`
@@ -99,14 +99,6 @@ analyse. Note that to be able to do this, a GitHub PAT token must be
supplied either in the environment variable GITHUB\_TOKEN or via standard
input using the `--github-auth-stdin` option.
#### `--[no-]calculate-baseline`
\[Advanced] Calculate baseline information about the code being
analyzed and add it to the database. By default, this is enabled unless
the source root is the root of a filesystem. This flag can be used to
either disable, or force the behavior to be enabled even in the root of
the filesystem.
#### `--[no-]allow-missing-source-root`
\[Advanced] Proceed even if the specified source root does not exist.
@@ -117,7 +109,17 @@ the filesystem.
build tracing," which allows integration into existing build workflows
when an explicit build command is not available. For information about
when and how to use this feature, please refer to our documentation at
"[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis)."
[AUTOTITLE](/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases).
### Baseline calculation options
#### `--[no-]calculate-baseline`
\[Advanced] Calculate baseline information about the code being
analyzed and add it to the database. By default, this is enabled unless
the source root is the root of a filesystem. This flag can be used to
either disable, or force the behavior to be enabled even in the root of
the filesystem.
### Extractor selection options

6
content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md
View File

@@ -1,6 +1,6 @@
---
title: database interpret-results
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -238,8 +238,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

8
content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md
View File

@@ -1,6 +1,6 @@
---
title: database run-queries
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -164,7 +164,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`
@@ -301,8 +301,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

8
content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md
View File

@@ -1,6 +1,6 @@
---
title: database upgrade
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -69,8 +69,8 @@ doesn't matter; it is an error if a pack name is found in two different
places through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.
@@ -169,7 +169,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`

8
content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md
View File

@@ -1,6 +1,6 @@
---
title: dataset upgrade
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -65,8 +65,8 @@ doesn't matter; it is an error if a pack name is found in two different
places through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.
@@ -165,7 +165,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`

8
content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md
View File

@@ -1,6 +1,6 @@
---
title: execute queries
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -159,7 +159,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`
@@ -290,8 +290,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

4
content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md
View File

@@ -1,6 +1,6 @@
---
title: execute query-server
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -119,7 +119,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`

4
content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md
View File

@@ -1,6 +1,6 @@
---
title: execute query-server2
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -118,7 +118,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`

8
content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md
View File

@@ -1,6 +1,6 @@
---
title: execute upgrades
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -82,8 +82,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.
@@ -168,7 +168,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`

75
content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md Normal file
View File

@@ -0,0 +1,75 @@
---
title: generate extensible-predicate-metadata
intro: |-
[Experimental] [Deep plumbing] Report the extensible predicates
found in the given pack.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
ghes: '*'
topics:
- Advanced Security
- Code scanning
- CodeQL
type: reference
product: '{% data reusables.gated-features.codeql %}'
autogenerated: codeql-cli
---
<!-- Content after this section is automatically generated -->
{% data reusables.codeql-cli.man-pages-version-note %}
## Synopsis
```shell copy
codeql generate extensible-predicate-metadata <options>... -- <pack-root-dir>
```
## Description
\[Experimental] \[Deep plumbing] Report the extensible predicates
found in the given pack.
## Primary options
#### `<pack-root-dir>`
\[Mandatory] The pack root directory for which we are reporting
extensible predicate metadata.
### Common options
#### `-h, --help`
Show this help text.
#### `-J=<opt>`
\[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
#### `-v, --verbose`
Incrementally increase the number of progress messages printed.
#### `-q, --quiet`
Incrementally decrease the number of progress messages printed.
#### `--verbosity=<level>`
\[Advanced] Explicitly set the verbosity level to one of errors,
warnings, progress, progress+, progress++, progress+++. Overrides `-v`
and `-q`.
#### `--logdir=<dir>`
\[Advanced] Write detailed logs to one or more files in the given
directory, with generated names that include timestamps and the name of
the running subcommand.
(To write a log file with a name you have full control over, instead
give `--log-to-stderr` and redirect stderr as desired.)

10
content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md
View File

@@ -1,6 +1,6 @@
---
title: generate query-help
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -41,10 +41,10 @@ Generate end-user query help from .qhelp files.
- A .qhelp file to render.
- A .ql file with a corresponding .qhelp file to render.
- A directory that will be searched recursively for .ql files with
corresponding .qhelp files.
corresponding .qhelp files.
- A .qls file that defines a particular set of queries.
- The basename of a "well-known" .qls file exported by one of the
installed QL packs.
installed QL packs.
#### `--format=<format>`
@@ -119,8 +119,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

1
content/code-security/codeql-cli/codeql-cli-manual/index.md
View File

@@ -53,6 +53,7 @@ children:
- /execute-query-server
- /execute-query-server2
- /execute-upgrades
- /generate-extensible-predicate-metadata
- /generate-log-summary
- /generate-query-help
- /github-upload-results

6
content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md
View File

@@ -1,6 +1,6 @@
---
title: pack bundle
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -120,8 +120,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md
View File

@@ -1,6 +1,6 @@
---
title: pack ci
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -119,8 +119,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-create.md
View File

@@ -1,6 +1,6 @@
---
title: pack create
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -122,8 +122,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-download.md
View File

@@ -1,6 +1,6 @@
---
title: pack download
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -112,8 +112,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-install.md
View File

@@ -1,6 +1,6 @@
---
title: pack install
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -146,8 +146,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md
View File

@@ -1,6 +1,6 @@
---
title: pack ls
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -61,8 +61,8 @@ List of CodeQL pack groups to include or exclude from this operation. A
qlpack in the given workspace is included if:
- It is in at least one of the groups listed without a minus sign (this
condition is automatically satisfied if there are no groups listed
without a minus sign), and
condition is automatically satisfied if there are no groups listed
without a minus sign), and
- It is not in any group listed with a minus sign
### Common options

10
content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md
View File

@@ -1,6 +1,6 @@
---
title: pack publish
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -120,8 +120,8 @@ List of CodeQL pack groups to include or exclude from this operation. A
qlpack in the given workspace is included if:
- It is in at least one of the groups listed without a minus sign (this
condition is automatically satisfied if there are no groups listed
without a minus sign), and
condition is automatically satisfied if there are no groups listed
without a minus sign), and
- It is not in any group listed with a minus sign
### Options to set up compilation environment
@@ -158,8 +158,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md
View File

@@ -1,6 +1,6 @@
---
title: pack resolve-dependencies
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -135,8 +135,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md
View File

@@ -1,6 +1,6 @@
---
title: pack upgrade
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -112,8 +112,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

12
content/code-security/codeql-cli/codeql-cli-manual/query-compile.md
View File

@@ -1,6 +1,6 @@
---
title: query compile
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -33,8 +33,8 @@ codeql query compile [--check-only] [--keep-going] [--threads=<num>] [--ram=<MB>
Compile or check QL code.
Compile one or more queries. Usually the main outcome of this command is
that the compiled version of the query is written to a *compilation
cache* where it will be found when the query is later executed. Other
that the compiled version of the query is written to a _compilation
cache_ where it will be found when the query is later executed. Other
output options are mostly for debugging.
## Primary options
@@ -47,7 +47,7 @@ output options are mostly for debugging.
- A directory which will be searched recursively for .ql files.
- A .qls file that defines a particular set of queries.
- The basename of a "well-known" .qls file exported by one of the
installed QL packs.
installed QL packs.
#### `-n, --check-only`
@@ -197,8 +197,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

8
content/code-security/codeql-cli/codeql-cli-manual/query-run.md
View File

@@ -1,6 +1,6 @@
---
title: query run
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -148,7 +148,7 @@ below this percentage.
#### `--external=<pred>=<file.csv>`
A CSV file that contains rows for external predicate *\<pred>*.
A CSV file that contains rows for external predicate `<pred>`.
Multiple `--external` options can be supplied.
#### `--xterm-progress=<mode>`
@@ -285,8 +285,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md
View File

@@ -4,7 +4,7 @@ intro: |-
[Experimental] [Deep plumbing] Determine accessible extensions for
the given paths to pack roots. This includes machine learning models and
data extensions.
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -78,8 +78,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md
View File

@@ -1,6 +1,6 @@
---
title: resolve extensions
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -97,8 +97,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

8
content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md
View File

@@ -1,6 +1,6 @@
---
title: resolve files
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -42,11 +42,11 @@ The `--include`, `--exclude`, and `--prune` options all take glob
patterns, which can use the following wildcard characters:
- A single "?" matches any character other than a forward/backward
slash;
slash;
- A single "\*" matches any number of characters other than a
forward/backward slash;
forward/backward slash;
- The pattern "\*\*" matches zero or more complete directory
components.
components.
## Primary options

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md
View File

@@ -1,6 +1,6 @@
---
title: resolve library-path
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -108,8 +108,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md
View File

@@ -1,6 +1,6 @@
---
title: resolve ml-models
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -99,8 +99,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md
View File

@@ -1,6 +1,6 @@
---
title: resolve qlpacks
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -75,8 +75,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md
View File

@@ -1,6 +1,6 @@
---
title: resolve qlref
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -74,8 +74,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md
View File

@@ -1,6 +1,6 @@
---
title: resolve queries
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -117,8 +117,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md
View File

@@ -1,6 +1,6 @@
---
title: resolve upgrades
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -84,8 +84,8 @@ doesn't matter; it is an error if a pack name is found in two different
places through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.

6
content/code-security/codeql-cli/codeql-cli-manual/test-run.md
View File

@@ -1,6 +1,6 @@
---
title: test run
versions:
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghae: '*'
ghec: '*'
@@ -166,8 +166,8 @@ matter; it is an error if a pack name is found in two different places
through this list.
This is useful if you're temporarily developing a new version of a pack
that also appears in the default path. On the other hand, it is *not
recommended* to override this option in a config file; some internal
that also appears in the default path. On the other hand, it is _not
recommended_ to override this option in a config file; some internal
actions will add this option on the fly, overriding any configured
value.