1
0
mirror of synced 2025-12-22 11:26:57 -05:00

Update CodeQL CLI manual (#51377)

Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
This commit is contained in:
docs-bot
2024-06-27 10:30:04 -07:00
committed by GitHub
parent d7d0ebb95f
commit d7ed8ddaef
10 changed files with 55 additions and 3 deletions

View File

@@ -244,6 +244,14 @@ during database creation from a Code Scanning configuration file.
Download any missing queries before analyzing. Download any missing queries before analyzing.
### Options to control the model packs to be used
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
### Options to control the threat models to be used ### Options to control the threat models to be used
#### `--threat-model=<name>...` #### `--threat-model=<name>...`

View File

@@ -95,7 +95,7 @@ Choose your build mode based on the language you are analyzing:
`none`: The database will be created without building the source root. `none`: The database will be created without building the source root.
Available for JavaScript/TypeScript, Python, and Ruby. Also available in Available for JavaScript/TypeScript, Python, and Ruby. Also available in
beta for Java. beta for C# and Java.
`autobuild`: The database will be created by attempting to automatically `autobuild`: The database will be created by attempting to automatically
build the source root. Available for C/C++, C#, Go, Java/Kotlin, and build the source root. Available for C/C++, C#, Go, Java/Kotlin, and

View File

@@ -108,7 +108,7 @@ Choose your build mode based on the language you are analyzing:
`none`: The database will be created without building the source root. `none`: The database will be created without building the source root.
Available for JavaScript/TypeScript, Python, and Ruby. Also available in Available for JavaScript/TypeScript, Python, and Ruby. Also available in
beta for Java. beta for C# and Java.
`autobuild`: The database will be created by attempting to automatically `autobuild`: The database will be created by attempting to automatically
build the source root. Available for C/C++, C#, Go, Java/Kotlin, and build the source root. Available for C/C++, C#, Go, Java/Kotlin, and

View File

@@ -245,6 +245,14 @@ variable.
This overrides the GITHUB\_TOKEN environment variable. This overrides the GITHUB\_TOKEN environment variable.
### Options to specify which extensions to use when interpreting the results
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
### Options for finding QL packs (which may be necessary to interpret query suites) ### Options for finding QL packs (which may be necessary to interpret query suites)
#### `--search-path=<dir>[:<dir>...]` #### `--search-path=<dir>[:<dir>...]`

View File

@@ -98,6 +98,14 @@ codebase.
\[Advanced] Omit threat model configuration stored in the database \[Advanced] Omit threat model configuration stored in the database
during database creation from a Code Scanning configuration file. during database creation from a Code Scanning configuration file.
### Options to control the model packs to be used
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
### Options to control the threat models to be used ### Options to control the threat models to be used
#### `--threat-model=<name>...` #### `--threat-model=<name>...`

View File

@@ -81,6 +81,14 @@ human-readable representation of the results to standard output.
Omit evaluation of queries that already seem to have a BQRS result Omit evaluation of queries that already seem to have a BQRS result
stored in the output location. stored in the output location.
### Options to control the model packs to be used
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
### Options to control the threat models to be used ### Options to control the threat models to be used
#### `--threat-model=<name>...` #### `--threat-model=<name>...`

View File

@@ -11,7 +11,7 @@ topics:
type: reference type: reference
product: '{% data reusables.gated-features.codeql %}' product: '{% data reusables.gated-features.codeql %}'
autogenerated: codeql-cli autogenerated: codeql-cli
intro: 'Publishes a QL library pack to a package registry.' intro: Publishes a QL library pack to a package registry.
redirect_from: redirect_from:
- /code-security/codeql-cli/manual/pack-publish - /code-security/codeql-cli/manual/pack-publish
--- ---

View File

@@ -357,6 +357,14 @@ variable.
This overrides the GITHUB\_TOKEN environment variable. This overrides the GITHUB\_TOKEN environment variable.
### Options to control the extension packs
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
### Common options ### Common options
#### `-h, --help` #### `-h, --help`

View File

@@ -85,6 +85,12 @@ value.
(Note: On Windows the path separator is `;`). (Note: On Windows the path separator is `;`).
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
#### `--threat-model=<name>...` #### `--threat-model=<name>...`
A list of threat models to enable or disable. A list of threat models to enable or disable.

View File

@@ -105,6 +105,12 @@ value.
(Note: On Windows the path separator is `;`). (Note: On Windows the path separator is `;`).
#### `--model-packs=<`<name@range>>...
A list of CodeQL pack names, each with an optional version range, to be
used as model packs to customize the queries that are about to be
evaluated.
#### `--threat-model=<name>...` #### `--threat-model=<name>...`
A list of threat models to enable or disable. A list of threat models to enable or disable.