jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-01 00:04:41 -05:00
Code Issues Projects Releases Wiki Activity

Repo sync (#33561)

Browse Source 
Co-authored-by: Peter Bengtsson <peterbe@github.com>
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Co-authored-by: Chad Fawcett <me@chadf.ca>
This commit is contained in:
docs-bot
2024-06-18 10:47:03 -07:00
committed by GitHub
parent 7e62f2a18c
commit 6d3b76a726
9 changed files with 47 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md
View File

@@ -41,23 +41,13 @@ tools](https://developer.apple.com/downloads/index.action) and [Rosetta 2](https
{% endnote %}
### 1. Download the {% data variables.product.prodname_codeql_cli %} zip package
### 1. Download the {% data variables.product.prodname_codeql_cli %} tar archive
{% data reusables.codeql-cli.download-codeql-cli-zip %}
{% data reusables.codeql-cli.download-codeql-cli %}
You should always use the {% data variables.product.prodname_codeql %} bundle as this ensures compatibility and also gives much better performance than a separate download of the {% data variables.product.prodname_codeql_cli %} and checkout of the {% data variables.product.prodname_codeql %} queries. If you will only be running the CLI on one specific platform, download the appropriate `codeql-bundle-PLATFORM.tar.gz` file. Alternatively, you can download `codeql-bundle.tar.gz`, which contains the CLI for all supported platforms.
### 2. Extract the {% data variables.product.prodname_codeql_cli %} tar archive
#### Download information for macOS "Catalina" (or newer) users
{% data reusables.codeql-cli.download-info-macos-catalina-or-newer %}
### 2. Extract the zip archive
For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) simply extract the zip archive.
#### Extraction information for macOS "Catalina" (or newer) users
{% data reusables.codeql-cli.extraction-info-macos-catalina-or-newer %}
Extract the {% data variables.product.prodname_codeql_cli %} tar archive to a directory of your choosing.
### 3. Launch `codeql`

16
content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md
View File

@@ -26,13 +26,9 @@ For information on the most simple setup of the {% data variables.product.prodna
Some users prefer working with {% data variables.product.prodname_codeql %} query sources directly in order to work on or contribute to the Open Source shared queries. In order to do this, the following steps are recommended.
### 1. Download the {% data variables.product.prodname_codeql_cli %} zip
### 1. Download the {% data variables.product.prodname_codeql_cli %} tar archive
{% data reusables.codeql-cli.download-codeql-cli-zip %}
#### Download information for macOS "Catalina" (or newer) users
{% data reusables.codeql-cli.download-info-macos-catalina-or-newer %}
{% data reusables.codeql-cli.download-codeql-cli %}
### 2. Create a new {% data variables.product.prodname_codeql %} directory
@@ -73,17 +69,13 @@ see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-t
{% endnote %}
### 4. Extract the zip archive
### 4. Extract the {% data variables.product.prodname_codeql_cli %} tar archive
For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) simply extract the zip archive into the directory you created in step 2.
Extract the tar archive into the directory you created in step 2.
For example, if the path to your copy of the {% data variables.product.prodname_codeql %} repository is `$HOME/codeql-home/codeql-repo`, then extract the CLI into
`$HOME/codeql-home/`.
#### Extraction information for macOS "Catalina" (or newer) users
{% data reusables.codeql-cli.extraction-info-macos-catalina-or-newer %}
### 5. Launch `codeql`
{% data reusables.codeql-cli.launch-codeql %}