Reorganize and update information re downloading CodeQL zip to tar archive (#51051)
This commit is contained in:
@@ -41,23 +41,13 @@ tools](https://developer.apple.com/downloads/index.action) and [Rosetta 2](https
|
|||||||
|
|
||||||
{% endnote %}
|
{% 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
|
Extract the {% data variables.product.prodname_codeql_cli %} tar archive to a directory of your choosing.
|
||||||
|
|
||||||
{% 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 %}
|
|
||||||
|
|
||||||
### 3. Launch `codeql`
|
### 3. Launch `codeql`
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
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 %}
|
{% data reusables.codeql-cli.download-codeql-cli %}
|
||||||
|
|
||||||
#### Download information for macOS "Catalina" (or newer) users
|
|
||||||
|
|
||||||
{% data reusables.codeql-cli.download-info-macos-catalina-or-newer %}
|
|
||||||
|
|
||||||
### 2. Create a new {% data variables.product.prodname_codeql %} directory
|
### 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 %}
|
{% 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
|
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/`.
|
`$HOME/codeql-home/`.
|
||||||
|
|
||||||
#### Extraction information for macOS "Catalina" (or newer) users
|
|
||||||
|
|
||||||
{% data reusables.codeql-cli.extraction-info-macos-catalina-or-newer %}
|
|
||||||
|
|
||||||
### 5. Launch `codeql`
|
### 5. Launch `codeql`
|
||||||
|
|
||||||
{% data reusables.codeql-cli.launch-codeql %}
|
{% data reusables.codeql-cli.launch-codeql %}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
The {% data variables.product.prodname_codeql_cli %} download package is a zip archive containing tools, scripts, and
|
The {% data variables.product.prodname_codeql_cli %} download package is a tar archive containing tools, scripts, and
|
||||||
various {% data variables.product.prodname_codeql %}-specific files. If you don’t have a {% data variables.product.prodname_enterprise %} license then, by
|
various {% data variables.product.prodname_codeql %}-specific files. If you don’t have a {% data variables.product.prodname_enterprise %} license then, by
|
||||||
downloading this archive, you are agreeing to the [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_codeql %} Terms and
|
downloading this archive, you are agreeing to the [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_codeql %} Terms and
|
||||||
Conditions](https://securitylab.github.com/tools/codeql/license).
|
Conditions](https://securitylab.github.com/tools/codeql/license).
|
||||||
@@ -16,3 +16,5 @@ For {% data variables.product.product_name %}{% ifversion ghes %} {{ allVersions
|
|||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
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.
|
||||||
Reference in New Issue
Block a user