hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-01 19:55:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add section about using the API to download dbs

Browse Source
This commit is contained in:
james
2022-09-09 15:40:10 +01:00
parent c3b2d2bb5e
commit 3321c52b6c
5 changed files with 19 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/codeql/codeql-cli/creating-codeql-databases.rst
View File

@@ -379,17 +379,15 @@ The following example shows how you could use indirect build tracing in an Azure
# `codeql database analyze`
# then `codeql github upload-results` ...
Obtaining databases from LGTM.com
---------------------------------
`LGTM.com <https://lgtm.com>`__ analyzes thousands of open-source projects using
CodeQL. For each project on LGTM.com, you can download an archived CodeQL
database corresponding to the most recently analyzed revision of the code. These
databases can also be analyzed using the CodeQL CLI or used with the CodeQL
extension for Visual Studio Code.
.. include:: ../reusables/download-lgtm-database.rst
Obtaining databases from GitHub.com
-----------------------------------
.. include:: ../reusables/download-github-database.rst
Before running an analysis, unzip the databases and try :doc:`upgrading <upgrading-codeql-databases>` the
unzipped databases to ensure they are compatible with your local copy of the
CodeQL queries and libraries.
.. pull-quote::
Note

29
docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst
View File

@@ -47,22 +47,9 @@ Conditions <https://securitylab.github.com/tools/codeql/license>`__.
.. pull-quote:: Important
There are different versions of the CLI available to download, depending
on your use case:
- If you want to use the most up to date CodeQL tools and features, download the
version tagged ``latest``.
- If you want to create CodeQL databases to upload to LGTM Enterprise, download
the version that is compatible with the relevant LGTM Enterprise version
number. Compatibility information is included in the description for each
release on the `CodeQL CLI releases page
<https://github.com/github/codeql-cli-binaries/releases>`__ on GitHub. Using the
correct version of the CLI ensures that your CodeQL databases are
compatible with your version of LGTM Enterprise. For more information,
see `Preparing CodeQL databases to upload to LGTM
<https://help.semmle.com/lgtm-enterprise/admin/help/prepare-database-upload.html>`__
in the LGTM admin help.
There are several different versions of the CLI available to download, depending
on your use case. If you want to use the most up to date CodeQL tools and features, download the
version tagged ``latest``.
If you use Linux, Windows, or macOS version 10.14 ("Mojave") or earlier, simply
`download the zip archive
@@ -232,15 +219,7 @@ see ":doc:`About CodeQL packs <about-codeql-packs>`."
- For the most up to date CodeQL queries, check out the ``main`` branch.
This branch represents the very latest version of CodeQL's analysis.
- For the queries used in a particular LGTM Enterprise release, check out the
branch tagged with the relevant release number. For example, the branch
tagged ``v1.27.0`` corresponds to LGTM Enterprise 1.27. You must use this
version if you want to upload data to LGTM Enterprise. For further
information, see `Preparing CodeQL databases to upload to LGTM
<https://help.semmle.com/lgtm-enterprise/admin/help/prepare-database-upload.html>`__
in the LGTM admin help.
1. Extract the zip archive
4. Extract the zip archive
~~~~~~~~~~~~~~~~~~~~~~~~~~
For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier)

2
docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst
View File

@@ -37,6 +37,8 @@ If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP
For more information about running query tests, see ":ref:`Testing custom queries <testing-custom-queries>`" in the CodeQL CLI help.
.. include:: ../reusables/download-github-database.rst
Running a query
------------------------

5
docs/codeql/reusables/download-github-database.rst Normal file
View File

@@ -0,0 +1,5 @@
GitHub also stores CodeQL databases for over 200,000 repos on GitHub.com, which you can download using the API. The list of repos is constantly growing and evolving to make sure that it includes the most interesting codebases for security research.
To download a database from GitHub.com using the `GitHub CLI <https://cli.github.com/manual/gh_api>`__, use the following command::
gh api /repos/<owner>/<repo>/code-scanning/codeql/databases/<language> -H 'Accept: application/zip' > path/to/local/database.zip

6
docs/codeql/reusables/download-lgtm-database.rst
View File

@@ -1,6 +0,0 @@
To download a database from LGTM.com:
#. Log in to `LGTM.com <https://lgtm.com/>`__.
#. Find a project you're interested in and display the Integrations tab (for example, `Apache Kafka <https://lgtm.com/projects/g/apache/kafka/ci/>`__).
#. Scroll to the **CodeQL databases for local analysis** section at the bottom of the page.
#. Download databases for the languages that you want to explore.