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: content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,6 @@ title: Configuring CodeQL CLI in your CI system
3
3
shortTitle: Configure CodeQL CLI
4
4
intro: 'You can configure your continuous integration system to run the {% data variables.product.prodname_codeql_cli %}, perform {% data variables.product.prodname_codeql %} analysis, and upload the results to {% data variables.product.product_name %} for display as {% data variables.product.prodname_code_scanning %} alerts.'
5
5
product: '{% data reusables.gated-features.code-scanning %}'
For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](/code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli/)."
163
162
164
-
### Basic example
163
+
### Basic example of analyzing a CodeQL database
165
164
166
165
This example analyzes a {% data variables.product.prodname_codeql %} database stored at `/codeql-dbs/example-repo` and saves the results as a SARIF file: `/temp/example-repo-js.sarif`. It uses `--sarif-category` to include extra information in the SARIF file that identifies the results as JavaScript. This is essential when you have more than one {% data variables.product.prodname_codeql %} database to analyze for a single commit in a repository.
167
166
@@ -205,7 +204,7 @@ When you have decided on the most secure and reliable method for your CI server,
205
204
206
205
For more information, see [github upload-results](https://codeql.github.com/docs/codeql-cli/manual/github-upload-results/) in the documentation for the {% data variables.product.prodname_codeql_cli %}.
207
206
208
-
### Basic example
207
+
### Basic example of uploading results to {% data variables.product.product_name %}
209
208
210
209
This example uploads results from the SARIF file `temp/example-repo-js.sarif` to the repository `my-org/example-repo`. It tells the {% data variables.product.prodname_code_scanning %} API that the results are for the commit `deb275d2d5fe9a522a0b7bd8b6b6a1c939552718` on the `main` branch.
211
210
@@ -242,7 +241,7 @@ For more information about pack compatibility, see "[About {% data variables.pro
242
241
{% endnote %}
243
242
{% endif %}
244
243
245
-
### Basic example
244
+
### Basic example of downloading and using query packs
246
245
247
246
This example runs the `codeql database analyze` command with the `--download` option to:
Copy file name to clipboardExpand all lines: content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,10 +30,8 @@ structures. To get started quickly, we recommend adopting a relatively simple
30
30
setup, as outlined in the steps below.
31
31
32
32
If you use Linux, Windows, or macOS version 10.14 (“Mojave”) or earlier, simply
33
-
follow the steps below. For macOS version 10.15 (“Catalina”) or newer, steps 1
34
-
and 4 are slightly different—for further details, see the sections labeled
35
-
**Information for macOS “Catalina” (or newer) users**. If you are using macOS
36
-
on Apple Silicon (e.g. Apple M1), ensure that the [Xcode command-line developer
33
+
follow the steps below. For macOS version 10.15 (“Catalina”) or newer, there are additional notes for some of the steps. If you are using macOS
34
+
on Apple Silicon (for example, Apple M1), ensure that the [Xcode command-line developer
37
35
tools](https://developer.apple.com/downloads/index.action) and [Rosetta 2](https://support.apple.com/en-us/HT211861) are installed.
38
36
39
37
{% note %}
@@ -67,7 +65,7 @@ for the version you require.
67
65
If you want the CLI for a specific platform, download the appropriate `codeql-PLATFORM.zip` file.
68
66
Alternatively, you can download `codeql.zip`, which contains the CLI for all supported platforms.
69
67
70
-
#### Information for macOS “Catalina” (or newer) users
68
+
#### Download information for macOS “Catalina” (or newer) users
71
69
72
70
If you use macOS version 10.15 (“Catalina”), version 11 (“Big Sur”), or the upcoming version 12 (“Monterey”), you need to ensure that your web browser does not automatically extract zip files. If you use Safari, complete the following steps before downloading the {% data variables.product.prodname_codeql_cli %} zip archive:
73
71
@@ -81,7 +79,7 @@ If you use macOS version 10.15 (“Catalina”), version 11 (“Big Sur”), or
81
79
For Linux, Windows, and macOS users (version 10.14 “Mojave”, and earlier)
82
80
simply extract the zip archive.
83
81
84
-
#### Information for macOS “Catalina” (or newer) users
82
+
#### Extraction information for macOS “Catalina” (or newer) users
85
83
86
84
macOS “Catalina”, “Big Sur”, or “Monterey” users should run the following commands in the Terminal, where `${extraction-root}` is the path to the directory where you will extract the {% data variables.product.prodname_codeql_cli %} zip archive:
0 commit comments