зеркало из https://github.com/github/docs.git
Update setting up CodeQL docs (#52436)
This commit is contained in:
Родитель
543abb3fb9
Коммит
b786e9d0a6
|
@ -64,39 +64,41 @@ Extract the {% data variables.product.prodname_codeql_cli %} tar archive to a di
|
||||||
|
|
||||||
After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the following command to verify that the CLI is correctly configured to create and analyze databases:
|
After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the following command to verify that the CLI is correctly configured to create and analyze databases:
|
||||||
|
|
||||||
* `codeql resolve qlpacks` if `/<extraction-root>/codeql` is on the `PATH`.
|
* `codeql resolve packs` if `/<extraction root>/codeql` is on the `PATH`.
|
||||||
* `/<extraction-root>/codeql/codeql resolve qlpacks` otherwise.
|
* `/<extraction root>/codeql/codeql resolve packs` otherwise.
|
||||||
|
|
||||||
You should see output similar to the extract below, if successful:
|
If successful, you should see output similar to the extract below:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
codeql/cpp-all (/<extraction-root>/qlpacks/codeql/cpp-all/<version>)
|
Searching directories specified by `--additional-packs`. All directories have equal priority.
|
||||||
codeql/cpp-examples (/<extraction-root>/qlpacks/codeql/cpp-examples/<version>)
|
Searching in:
|
||||||
codeql/cpp-queries (/<extraction-root>/qlpacks/codeql/cpp-queries/<version>)
|
No packs were found at this location.
|
||||||
codeql/csharp-all (/<extraction-root>/qlpacks/codeql/charp-all/<version>)
|
Searching directories specified by `--search-path`. Directories are searched in order.
|
||||||
codeql/csharp-examples (/<extraction-root>/qlpacks/codeql/charp-examples/<version>)
|
Searching the root of the CodeQL distribution.
|
||||||
codeql/csharp-queries (/<extraction-root>/qlpacks/codeql/charp-queries/<version>)
|
Searching in:
|
||||||
codeql/java-all (/<extraction-root>/qlpacks/codeql/java-all/<version>)
|
<extraction root>
|
||||||
codeql/java-examples (/<extraction-root>/qlpacks/codeql/java-examples/<version>)
|
The following packs were found:
|
||||||
codeql/java-queries (/<extraction-root>/qlpacks/codeql/java-queries/<version>)
|
codeql/java-all@<version>: (library) <extraction root>/qlpacks/codeql/javat-all/<version>/qlpack.yml
|
||||||
codeql/javascript-all (/<extraction-root>/qlpacks/codeql/javascript-all/<version>)
|
codeql/java-queries@<version>: (query) <extraction root>/qlpacks/codeql/java-queries/<version>/qlpack.yml
|
||||||
codeql/javascript-examples (/<extraction-root>/qlpacks/codeql/javascript-examples/<version>)
|
codeql/javascript-all@<version>: (library) <extraction root>/qlpacks/codeql/javascript-all/<version>/qlpack.yml
|
||||||
codeql/javascript-queries (/<extraction-root>/qlpacks/codeql/javascript-queries/<version>)
|
codeql/javascript-queries@<version>: (query) <extraction root>/qlpacks/codeql/javascript-queries/<version>/qlpack.yml
|
||||||
codeql/python-all (/<extraction-root>/qlpacks/codeql/python-all/<version>)
|
codeql/swift-all@<version>: (library) <extraction root>/qlpacks/codeql/swift-all/<version>/qlpack.yml
|
||||||
codeql/python-examples (/<extraction-root>/qlpacks/codeql/python-examples/<version>)
|
codeql/swift-queries@<version>: (query) <extraction root>/qlpacks/codeql/swift-queries/<version>/qlpack.yml
|
||||||
codeql/python-queries (/<extraction-root>/qlpacks/codeql/python-queries/<version>)
|
|
||||||
codeql/ruby-all (/<extraction-root>/qlpacks/codeql/ruby-all/<version>)
|
|
||||||
codeql/ruby-examples (/<extraction-root>/qlpacks/codeql/ruby-examples/<version>)
|
|
||||||
codeql/ruby-queries (/<extraction-root>/qlpacks/codeql/ruby-queries/<version>)
|
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The results have been truncated for brevity. The actual results will be longer and more detailed.
|
||||||
|
|
||||||
You should check that the output contains the expected languages and also that the directory location for the qlpack files is correct. The location should be within the extracted {% data variables.product.prodname_codeql_cli %} bundle, shown in the earlier example as `<extraction root>`. If the {% data variables.product.prodname_codeql_cli %} is unable to locate the qlpacks for the expected languages, check that you downloaded the {% data variables.product.prodname_codeql %} bundle and not a standalone copy of the {% data variables.product.prodname_codeql_cli %}.
|
You should check that the output contains the expected languages and also that the directory location for the qlpack files is correct. The location should be within the extracted {% data variables.product.prodname_codeql_cli %} bundle, shown in the earlier example as `<extraction root>`. If the {% data variables.product.prodname_codeql_cli %} is unable to locate the qlpacks for the expected languages, check that you downloaded the {% data variables.product.prodname_codeql %} bundle and not a standalone copy of the {% data variables.product.prodname_codeql_cli %}.
|
||||||
|
|
||||||
You can also run `codeql resolve languages` to show which languages are available for database creation. This will list the languages supported by default in your {% data variables.product.prodname_codeql_cli %} package.
|
You can also run `codeql resolve languages` to show which languages are available for database creation. This will list the languages supported by default in your {% data variables.product.prodname_codeql_cli %} package.
|
||||||
|
|
||||||
Optionally, you can download some CodeQL packs containing pre-compiled queries you would like to run. For more information, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs)."
|
Optionally, you can download some CodeQL packs containing pre-compiled queries you would like to run. For more information, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs)."
|
||||||
|
|
||||||
|
The `codeql resolve packs` command is useful for diagnosing problems when the {% data variables.product.prodname_codeql_cli %} is unable to locate query packs that you expect to be available for analysis.
|
||||||
|
|
||||||
|
>[!NOTE] The `codeql resolve packs` command is available in the {% data variables.product.prodname_codeql_cli %} versions 2.19.0 and later. For earlier versions of the CLI, you should run the `codeql resolve qlpacks` command, which produces similar, but less detailed output.
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
To learn how to prepare your code to be analyzed by the {% data variables.product.prodname_codeql_cli %}, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis)."
|
To learn how to prepare your code to be analyzed by the {% data variables.product.prodname_codeql_cli %}, see "[AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis)."
|
||||||
|
|
Загрузка…
Ссылка в новой задаче