text stringlengths 12 91.7k | metadata dict |
|---|---|
Prerequisites
Before you enable for your repository, you should be familiar with their functionality and purpose. See AUTOTITLE.
Enabling preset rules
1. In the "" section, to the right of " rules", click .
!Screenshot of the "" page for a repository. The gear icon is highlighted with an orange outline.
1. In the... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/prioritize-with-preset-rules.md",
"title": "Using GitHub preset rules to prioritize Dependabot alerts"
} |
Re-running a job
1. To the right of the name of manifest file that you're interested in, click Recent update jobs.
1. To the right of the affected manifest file, click Check for updates to re-run a job and check for new updates to dependencies for that ecosystem.
Re-running a job
1. Under your repository name, clic... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/re-run-dependabot-jobs.md",
"title": "Re-running Dependabot jobs on GitHub Actions"
} |
About configuring to only access private registries
For more information about private registry support and configuration, see AUTOTITLE.
You can configure to access only private registries by removing calls to public registries. This can only be configured for the ecosystems listed in this article.
[!NOTE]
Befor... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/remove-access-to-public-registries.md",
"title": "Removing Dependabot access to public registries"
} |
When you enable for , will help ensure that references to actions in a repository's workflow.yml file and reusable workflows used inside workflows are kept up to date. For more information, see AUTOTITLE.
Enabling for actions
1. If you have already enabled for other ecosystems or package managers, simply open the ... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/auto-update-actions.md",
"title": "Keeping your actions up to date with Dependabot"
} |
When detects vulnerable dependencies in a repository, it generates alerts. For more information, see AUTOTITLE.
You can enable or disable for:
Your personal account
Your repository
Your organization
Your enterprise
[!NOTE]
An enterprise owner must first set up for your enterprise before you can configure . For... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-dependabot-alerts.md",
"title": "Configuring Dependabot alerts"
} |
Enabling for your repository
1. To enable , you first need to enable . Under "", to the right of , click Enable.
1. To the right of , click Enable.
Enabling for your organization
You can enable for repositories in your organization with a . are collections of security settings that you can customize and apply at s... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-malware-alerts.md",
"title": "Configuring Dependabot malware alerts"
} |
<!--Marketing-LINK: From home page "Learn more about Dependabot".--
Managing for your repositories
You can enable or disable for all qualifying repositories owned by your personal account or organization. For more information, see AUTOTITLE or AUTOTITLE.
You can also enable or disable for an individual repository.
... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-security-updates.md",
"title": "Configuring Dependabot security updates"
} |
<!--Marketing-LINK: From /features/security/software-supply-chain page "About version updates for dependencies".--
Enabling
You enable by committing a dependabot.yml configuration file to your repository.
If you enable the feature in your settings page, GitHub creates a basic file which you can edit, otherwise you c... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configure-version-updates.md",
"title": "Configuring Dependabot version updates"
} |
Multi-ecosystem updates allow you to consolidate pull requests across different package ecosystems into a single PR per group. See AUTOTITLE.
Prerequisites
A repository with dependencies in multiple package ecosystems
An existing .github/dependabot.yml file. See AUTOTITLE.
1. Define your multi-ecosystem group in y... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-multi-ecosystem-updates.md",
"title": "Configuring multi-ecosystem updates for Dependabot"
} |
The dependency graph is a summary of the manifest and lock files stored in a repository and any dependencies that are submitted for the repository using the . For more information, see AUTOTITLE.
When the dependency graph is first enabled, any manifest and lock files for supported ecosystems are parsed immediately. The... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/enable-dependency-graph.md",
"title": "Enabling the dependency graph"
} |
Viewing the dependency graph
The dependency graph shows the dependencies and dependents of your repository. For information about the detection of dependencies and which ecosystems are supported, see AUTOTITLE.
1. Optionally, use the search bar to find a specific dependency or set of dependencies. You can use the key... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/explore-dependencies.md",
"title": "Exploring the dependencies of a repository"
} |
For background on how innersource advisories work and who can create them, see AUTOTITLE.
Prerequisites
Innersource advisories can only be created in enterprises with an active or license.
Creating innersource advisories
To create an innersource advisory:
1. Create and install a with the enterpriseinnersourcevulne... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/manage-innersource-advisories.md",
"title": "Managing innersource advisories"
} |
Prerequisites
Dependency graph must be enabled for the repository for you to enable automatic dependency submission.
You must also enable for the repository in order to use automatic dependency submission. For more information, see AUTOTITLE.
[!NOTE]
For ecosystems that support graph jobs, you do not need to enable... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/submit-dependencies-automatically.md",
"title": "Configuring automatic dependency submission for your repository"
} |
The is a method of submitting data to the dependency graph. It allows you to submit dependencies that are not captured by static analysis. For more information, see AUTOTITLE.
Submitting dependencies at build-time
You can use the in a workflow to submit dependencies for your project when your project is built.
Usi... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/use-dependency-submission-api.md",
"title": "Using the dependency submission API"
} |
Prerequisites
Before you can validate the authenticity of a release and its assets on the command line, you need to install the .
Verifying immutable releases and local artifacts
1. On the command line, open the repository containing the release you want to verify.
1. To verify a release exists and is immutable, run t... | {
"source": "github-docs/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/verify-release-integrity.md",
"title": "Verifying the integrity of a release"
} |
The Model Context Protocol (MCP) server lets you run directly from agent mode, , and other MCP-compatible tools. Scan your code for exposed keys, tokens, and credentials as you work, and fix them before you push.
The secret scanning tools are only available via the remote MCP server. Local MCP server configurations... | {
"source": "github-docs/code-security/how-tos/use-ghas-with-ai-coding-agents/scan-for-secrets-with-github-mcp-server.md",
"title": "Scanning for secrets with the GitHub MCP server"
} |
You can use security overview to see which repositories and teams have already enabled each security feature, and where people need more encouragement to adopt these features.
[!NOTE] "Pull request alerts" are reported as enabled only when has analyzed at least one pull request since alerts were enabled for the reposi... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md",
"title": "Assessing adoption of security features"
} |
Exploring the security risks in your code
You can use the different views on your tab to explore the security risks in your code.
Overview: use to explore trends in Detection, Remediation, and Prevention of security alerts.
Risk: use to explore the current state of repositories, across all alert types.
Assessments:... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-code-security-risk.md",
"title": "Assessing the security risk of your code"
} |
The CSV file you download will contain data corresponding to the filters you have applied to security overview. For example, if you add the filter dependabot-alerts:enabled, your file will only contain data for repositories that have enabled .
[!NOTE]
In the "Teams" column of the CSV file, each repository will list a... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/export-data.md",
"title": "Exporting data from security overview"
} |
1. Towards the top-right side of the report, select the dropdown menu, then click Download CSV.
Next steps
To better understand the fields of your CSV file, see AUTOTITLE. | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/export-risk-report-csv.md",
"title": "Exporting the secret risk assessment report to CSV"
} |
[!NOTE]
1. By default, security overview shows alerts for all native tools. To display alerts for a specific tool, replace tool:github in the filter text box:
tool:dependabot shows only alerts for dependencies identified by
tool:secret-scanning shows only alerts for secrets identified by
tool:codeql s... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/find-insecure-repositories.md",
"title": "Finding repositories with security alerts using security overview"
} |
You can view metrics for to track and prioritize vulnerabilities across your organization. For more information about the available metrics and how to use them, see AUTOTITLE.
This article explains how to access and view these metrics for your organization.
Viewing metrics for for an organization
1. In the sidebar, ... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-dependabot-alerts.md",
"title": "Viewing metrics for Dependabot alerts"
} |
Viewing pull request metrics for an organization
1. In the sidebar, under "Insights", click pull requests.
1. Optionally, use the date picker to set the time range. The date picker will show data based on the pull request alerts' creation dates.
1. Optionally, apply filters in the search box at the top of the page.
... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md",
"title": "Viewing metrics for pull request alerts"
} |
Viewing metrics for push protection for an organization
1. In the sidebar, under "Insights", click .
1. Click on an individual secret type or repository to see the associated for your organization.
Viewing metrics for push protection for an enterprise
You can view metrics for push protection across organizations ... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-secret-scanning-push-protection.md",
"title": "Viewing metrics for {% data variables.product.prodname_secret_scanning %} push protection"
} |
About the public monitoring page
The Public monitoring page is a dedicated view within the enterprise-level security overview. It displays alerts for secrets detected in public repositories across that are attributed to your enterprise members or users with an email matching your enterprise's verified domain.
[!NOTE]... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-public-monitoring-alerts.md",
"title": "Viewing public monitoring alerts"
} |
The overview page in security overview provides a consolidated dashboard of your organization or enterprise's security landscape. You can filter the dashboard by time period, tool, and other criteria to focus on specific areas of interest. For more information about the overview dashboard, available metrics, and access... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-security-insights.md",
"title": "Viewing security insights"
} |
For more information, see AUTOTITLE.
If you have admin permissions to a repository that contains multiple packages, you can choose which package the "Used by" section represents.
1. Under "", click the drop-down menu in the "Used by counter" section and choose a package. | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/change-used-by-data.md",
"title": "Changing the \"used by\" data for a repository"
} |
After configuring using default setup or a custom workflow, you can watch the output of the actions as they run. For information about logs for other setups, see AUTOTITLE.
You'll see a list that includes an entry for running the workflow. The text of the entry is the title you gave your commit message.
!Scre... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/view-code-scanning-logs.md",
"title": "Viewing code scanning logs from GitHub Actions"
} |
[!NOTE] Metrics for custom patterns are in and subject to change.
Activity overviews for custom patterns are available at the repository, organization, and enterprise levels. Each overview displays alerts generated and push protection blocks over the last 30 days.
1. Under "Custom patterns", click the custom pattern y... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/view-custom-pattern-metrics.md",
"title": "Viewing metrics for custom patterns"
} |
When fail or behave unexpectedly, job logs show you exactly what happened. Access job logs from the dependency graph to debug issues quickly. For background on what job logs contain and the types of jobs records, see AUTOTITLE.
Viewing job logs
The job logs list is accessible from the dependency graph tab in your ... | {
"source": "github-docs/code-security/how-tos/view-and-interpret-data/view-dependabot-logs.md",
"title": "Viewing Dependabot job logs"
} |
Code coverage measures what percentage of your source code is executed when your test suite runs. displays a coverage percentage on pull requests after you upload a Cobertura XML coverage report.
How coverage is calculated
The coverage percentage represents the number of lines covered by tests divided by the total nu... | {
"source": "github-docs/code-security/reference/code-quality/code-coverage.md",
"title": "Code coverage reference"
} |
-powered analysis
uses to perform rule-based analysis of pull requests and your default branch.
Findings for your default branch appear under the "" dashboard under your repository's tab.
Findings on pull requests appear as comments made by .
suggestions are provided for findings where possible.
Scan information... | {
"source": "github-docs/code-security/reference/code-quality/codeql-detection.md",
"title": "CodeQL-powered analysis for Code Quality"
} |
uses the following queries to analyze C code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/csharp-queries.md",
"title": "C# CodeQL queries for Code Quality"
} |
uses the following queries to analyze Go code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/go-queries.md",
"title": "Go CodeQL queries for Code Quality"
} |
uses the following queries to analyze Java code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/java-queries.md",
"title": "Java CodeQL queries for Code Quality"
} |
uses the following queries to analyze JavaScript code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/javascript-queries.md",
"title": "JavaScript CodeQL queries for Code Quality"
} |
uses the following queries to analyze Python code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/python-queries.md",
"title": "Python CodeQL queries for Code Quality"
} |
uses the following queries to analyze Ruby code and detect code quality issues on:
Your default branch, with results shown on the repository's "" dashboard
Pull requests, with findings shown as comments made by
suggestions are provided for findings where possible. | {
"source": "github-docs/code-security/reference/code-quality/codeql-queries/ruby-queries.md",
"title": "Ruby CodeQL queries for Code Quality"
} |
This article provides definitions for the metrics and scores used by .
You can see the rule-based results for your repository on your tab, in the tab under "".
Metric definitions
The following table provides definitions for each metric that is reported for your repository.
Severity levels
Severity levels are used t... | {
"source": "github-docs/code-security/reference/code-quality/metrics-and-ratings.md",
"title": "Metrics and scores reference"
} |
The log and diagnostic information available to you depends on the method you use for in your repository. You can check the type of you're using in the tab of your repository, by using the Tool drop-down menu in the alert list. To access this page, see AUTOTITLE.
Logs on
You can see analysis and diagnostic informa... | {
"source": "github-docs/code-security/reference/code-scanning/code-scanning-logs.md",
"title": "Code scanning logs"
} |
Autobuild steps for compiled languages
-hosted runners are always run with the software required by autobuild. If you use self-hosted runners for , you may need to install additional software to use the autobuild process. Additionally, if your repository requires a specific version of a build tool, you may need to inst... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/build-options-for-compiled-languages.md",
"title": "CodeQL build options and steps for compiled languages"
} |
pack compatibility
When a query pack is published, it includes pre-compiled representations of all the queries in it to increase analysis speed. However, if the version of that performs the analysis is over 6 months newer than the the version that ran codeql pack publish, it may be necessary to compile the queries fro... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli/codeql-query-packs.md",
"title": "CodeQL query packs reference"
} |
When you save analysis results from the in CSV format, each line corresponds to an alert, containing a comma-separated list with the following information:
PropertyDescriptionExample
---------------
Name Name of the query that identified the result. Inefficient regular expression
Description Description of the quer... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md",
"title": "CodeQL CLI CSV output"
} |
About exit codes
The reports the status of each command it runs as an exit code.
This exit code provides information for subsequent commands or for other tools that rely on the .
0
Success, normal termination.
1
The command successfully determined that the answer to your question is "no".
This exit code is only used... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md",
"title": "Exit codes"
} |
<!--The CodeQL CLI man pages include a link to this article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/codeql-cli-docs/extractor-options.--
Available extractor options
Each extractor defines its own set of configuration options for building a queryable database from ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md",
"title": "Extractor options"
} |
About SARIF output
SARIF is designed to represent the output of a broad range of static analysis tools, and there are many features in the SARIF specification that are
considered "optional". This document details the output produced when using the format type sarifv2.1.0, which corresponds to the SARIF v2.1.0.csd1 spec... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md",
"title": "CodeQL CLI SARIF output"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
Description
Convert result data from BQRS into other forms.
The... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md",
"title": "bqrs decode"
} |
Omit column titles for text and csv formats
--entities=<fmt[,<fmt...]
\[Advanced] Control how result columns of entity type are shown. A
comma-separated list of the following choices:
url: A URL referring to a source location, if the query was compiled
to produce such URLs for entity types.
string: A string computed b... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md",
"title": "bqrs decode"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql bqrs diff <options>... -- <file1> <file2>
Description
Compute the difference between two result sets.
Options
Primary Options
<file1
\[Mandatory] First BQRS file to ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md",
"title": "bqrs diff"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql bqrs hash <options>... -- <file>
Description
\[Plumbing] Compute a stable hash of a BQRS file.
Options
Primary Options
<file
\[Mandatory] BQRS file to hash.
Common ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md",
"title": "bqrs hash"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql bqrs info <options>... -- <file>
Description
Display metadata for a BQRS file.
This command displays an overview of the data contained in the compact
binary BQRS file t... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md",
"title": "bqrs info"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefi... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md",
"title": "bqrs interpret"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>
Description
\[Experimental] Add a piece of diagnostic information to a database... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md",
"title": "database add-diagnostic"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database analyze --format=<format> --output=<output> [--threads=<num>] [--ram=<MB>] <options>... -- <database> <query|dir|suite|pack>...
Description
Analyze a database,... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md",
"title": "database analyze"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database bundle --output=<output> <options>... -- <database>
Description
Create a relocatable archive of a CodeQL database.
A command that zips up the useful parts of t... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md",
"title": "database bundle"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database cleanup <options>... -- <database>
Description
Compact a CodeQL database on disk.
Delete temporary data, and generally make a database as small as
possible on ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md",
"title": "database cleanup"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database create [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--source-root=<dir>] [--threads=<num>] [--ram=<MB>] [--command=<command>] [--... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md",
"title": "database create"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>
Description
\[Experimental] Export diagnostic information from a database f... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md",
"title": "database export-diagnostics"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>
Description
\[Plumbing] Final steps in database creation.
Finalize a dat... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md",
"title": "database finalize"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
Description
\[Advanced] \[Plumbing] Import unfinalized ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md",
"title": "database import"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database index-files --language=<lang> [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>
Description
\[Plumbi... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md",
"title": "database index-files"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database init --source-root=<dir> [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--extractor-option=<extractor-option-name=value>] <options>... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md",
"title": "database init"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database interpret-results --format=<format> --output=<output> [--threads=<num>] <options>... -- <database> <file|dir|suite>...
Description
\[Plumbing] Interpret comput... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md",
"title": "database interpret-results"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database print-baseline <options>... -- <database>
Description
\[Plumbing] Print a summary of the baseline lines of code seen.
This command will print to standard out t... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md",
"title": "database print-baseline"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database run-queries [--threads=<num>] [--ram=<MB>] <options>... -- <database> <query|dir|suite|pack>...
Description
\[Plumbing] Run a set of queries together.
Run one ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md",
"title": "database run-queries"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database trace-command [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database> <command>...
Description
\[Plumbing]... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md",
"title": "database trace-command"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database unbundle <options>... -- <archive>
Description
Extracts a CodeQL database archive.
This command extracts a CodeQL database archive created by codeql database b... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md",
"title": "database unbundle"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>
Description
Upgrade a database so it is usable by the current tools.
This rewrites a CodeQL d... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md",
"title": "database upgrade"
} |
Include any relevant downgrades if there are no upgrades
Options to control evaluation of upgrade queries
--[no-]tuple-counting
\[Advanced] Display tuple counts for each evaluation step in the query
evaluator logs. If the --evaluator-log option is provided, tuple
counts will be included in both the text-based and str... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md",
"title": "database upgrade"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql dataset check <options>... -- <dataset>
Description
\[Plumbing] Check a particular dataset for internal consistency.
This command is most commonly useful to developers ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md",
"title": "dataset check"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql dataset cleanup <options>... -- <dataset>
Description
\[Plumbing] Clean up temporary files from a dataset.
This should not be used for datasets still under construction... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md",
"title": "dataset cleanup"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...
Description
\[Plumbing] Import a set of TRAP files to a raw dataset.
Create a dat... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md",
"title": "dataset import"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql dataset measure --output=<file> [--threads=<num>] <options>... -- <dataset>
Description
\[Plumbing] Collect statistics about the relations in a particular
dataset.
This... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md",
"title": "dataset measure"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql dataset upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <dataset>
Description
\[Plumbing] Upgrade a dataset so it is usable by the current tools. | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md",
"title": "dataset upgrade"
} |
This does the same as
codeql database upgrade but works on a raw dataset rather than an entire database.
Options
Primary Options
<dataset
\[Mandatory] Path to the raw QL dataset to upgrade.
--search-path=<dir[:<dir...]
A list of directories under which QL packs containing upgrade recipes
may be found. Each director... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md",
"title": "dataset upgrade"
} |
Include any relevant downgrades if there are no upgrades
Options to control evaluation of upgrade queries
--[no-]tuple-counting
\[Advanced] Display tuple counts for each evaluation step in the query
evaluator logs. If the --evaluator-log option is provided, tuple
counts will be included in both the text-based and str... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md",
"title": "dataset upgrade"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...
Description
\[Experimental] \[Plumbing] Add a piece of diagnostic i... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md",
"title": "diagnostic add"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql diagnostic export --format=<format> [--output=<output>] <options>...
Description
\[Experimental] Export diagnostic information for a failed analysis.
Available since v2... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md",
"title": "diagnostic export"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute cli-server <options>...
Description
\[Deep plumbing] Server for running multiple commands while avoiding
repeated JVM initialization.
Options
Primary Options
... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md",
"title": "execute cli-server"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute language-server --check-errors=<checkErrors> <options>...
Description
\[Plumbing] On-line support for the QL language in IDEs.
This command is only relevant for... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md",
"title": "execute language-server"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute queries [--output=<dir|file.bqrs>] [--threads=<num>] <options>... -- <dataset> <query|dir|suite|pack>...
Description
\[Plumbing] Run one or more queries against... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md",
"title": "execute queries"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute query-server <options>...
Description
\[Deprecated] \[Plumbing] Support for running queries from IDEs.
The
codeql execute query-server subcommand is unsupported... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md",
"title": "execute query-server"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute query-server2 [--threads=<num>] <options>...
Description
\[Plumbing] Support for running queries from IDEs.
This command is only relevant for authors of QL lang... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md",
"title": "execute query-server2"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql execute upgrades [--threads=<num>] <options>... -- <dataset> <script>...
Description
\[Plumbing] Run upgrade scripts on an existing raw QL dataset.
This command runs a ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md",
"title": "execute upgrades"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql generate extensible-predicate-metadata <options>... -- <pack-root-dir>
Description
\[Deep plumbing] Report the extensible predicates found in the given
pack.
Options
... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md",
"title": "generate extensible-predicate-metadata"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql generate log-summary <options>... -- <input> <result>
Description
\[Advanced] Create a summary of a structured log file.
This command creates a summary of a structured ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md",
"title": "generate log-summary"
} |
<!-- Content after this section is automatically generated --
Synopsis
codeql generate overlay-changes [--source-root=<dir>] [--output=<file>] <options>... -- <database>
Description
\[Plumbing] Generate a file that can be used for the
--overlay-changes option to
codeql database create when extracting an overlay datab... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md",
"title": "generate overlay-changes"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...
Description
Generate end-user query help from .qhelp files... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md",
"title": "generate query-help"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql github merge-results --sarif=<file> --output=<file> <options>...
Description
\[Deep plumbing] Merges multiple SARIF files into a single SARIF file.
Options
Primary Op... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md",
"title": "github merge-results"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=<url>] [--repository=<repository-name>] [--ref=<ref>] [--commit=<commit>] [--checkout-path=<path... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md",
"title": "github upload-results"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack add <options>... -- <scope/name[@range]>...
Description
Adds a list of QL library packs with optional version ranges as
dependencies of the current package, and th... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md",
"title": "pack add"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack bundle [--output=<file.tgz>] [--threads=<num>] [--ram=<MB>] <options>... -- <dir>
Description
\[Plumbing] Bundle a QL library pack.
This command bundles a QL libra... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md",
"title": "pack bundle"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack ci [--force] <options>... -- <dir>
Description
Clean install dependencies for this pack, verifying that the existing
lock file is up to date.
This command installs... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md",
"title": "pack ci"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack create [--output=<output>] [--threads=<num>] [--ram=<MB>] <options>... -- <dir>
Description
\[Plumbing] Builds the contents of a QL package from source code.
This ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md",
"title": "pack create"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...
Description
Download the set of qlpacks referenced by the query spec of the co... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md",
"title": "pack download"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>
Description
Initializes a qlpack in the specified directory.
The pack will be created i... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md",
"title": "pack init"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack install [--force] <options>... -- <dir>
Description
Install dependencies for this pack.
This command installs the dependencies of the pack. If a
codeql-pack.lock.y... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md",
"title": "pack install"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack ls <options>... -- <dir>
Description
\[Deep plumbing] List the CodeQL packages rooted at this directory.
This directory must contain a qlpack.yml or .codeqlmanifes... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md",
"title": "pack ls"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack packlist <options>... -- <dir>
Description
\[Plumbing] Compute the set of files to be included in a QL query pack
or library pack.
This command determines the set ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md",
"title": "pack packlist"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>
Description
Publishes a QL library pack to a package reg... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md",
"title": "pack publish"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.