jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -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

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