> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/ox-code.md).

# ox code

- [OX Scan Engines](https://docs.ox.security/ox-code/ox-scan-engines.md)
- [Code Security](https://docs.ox.security/ox-code/ox-scan-engines/code-security.md)
- [Custom Code Security Scanning](https://docs.ox.security/ox-code/ox-scan-engines/code-security/custom-code-security-scanning.md)
- [Secret and PII Scanning](https://docs.ox.security/ox-code/ox-scan-engines/managing-secret-and-pii-detection.md)
- [Defining Custom Secret and PII Patterns](https://docs.ox.security/ox-code/ox-scan-engines/managing-secret-and-pii-detection/managing-secret-and-pii-detection.md)
- [OX Code Scanning](https://docs.ox.security/ox-code/scanning.md)
- [Scanning Selected Repositories](https://docs.ox.security/ox-code/scanning/scanning-selected-repositories.md)
- [Scanning Multiple Branches](https://docs.ox.security/ox-code/scanning/multi-branch-support.md)
- [Scanning Code and Artifacts in CI/CD Pipelines](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines.md)
- [Pipeline Scan Settings](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/pipeline-scan-settings.md)
- [Integrating Source Control Platforms](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms.md)
- [App Pipeline Integration](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/app-pipeline-integration.md)
- [GitHub App](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/app-pipeline-integration/github-app.md)
- [Bitbucket App](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/app-pipeline-integration/bitbucket-app.md)
- [Webhooks Pipeline Integration](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/webhooks-pipeline-integration.md)
- [GitLab Webhooks](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/webhooks-pipeline-integration/gitlab-webhooks.md)
- [Direct CI/CD Integration](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration.md)
- [Creating CI/CD Integration Key](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/creating-ci-cd-integration-key.md)
- [GitHub Actions](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/github-actions.md)
- [GitLab CI/CD](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/gitlab-ci-cd.md)
- [Bitbucket Pipelines](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/bitbucket-pipelines.md)
- [Jenkins](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/jenkins.md)
- [Azure Pipelines and Azure DevOps](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/azure-pipelines-and-azure-devops.md)
- [Azure Pipelines](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/azure-pipelines-and-azure-devops/azure-pipelines.md)
- [OX Scan Extension for Azure DevOps](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/azure-pipelines-and-azure-devops/ox-scan-extension-for-azure-devops.md)
- [Generic CI](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/integrating-source-control-platforms/direct-source-control-pipeline-integration/generic-ci.md)
- [Understanding Pipeline Scan Results](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/understanding-pipeline-scan-results.md)
- [Pipeline Summary](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/understanding-pipeline-scan-results/pipeline-summary.md)
- [Pipeline Issues](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/understanding-pipeline-scan-results/pipeline-issues.md)
- [Docker Image Scanning in CI/CD Pipelines](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/docker-image-scanning-in-ci-cd-pipelines.md)
- [Securing Docker Images](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/artifacts-signing.md)
- [Gradle Dependency Resolution in CI/CD](https://docs.ox.security/ox-code/scanning/scanning-ci-cd-pipelines/gradle-dependency-resolution-in-ci-cd.md)
- [Monorepo Scanning](https://docs.ox.security/ox-code/scanning/monorepo-scanning.md)
- [OX IDE Integrations](https://docs.ox.security/ox-code/scanning/ox-ide-integrations.md)
- [OX IDE Extension (VS Code)](https://docs.ox.security/ox-code/scanning/ox-ide-integrations/ox-ide-extension.md)
- [Installing the OX IDE Extension](https://docs.ox.security/ox-code/scanning/ox-ide-integrations/ox-ide-extension/installing-the-ox-ide-extension.md)
- [Deploying the OX IDE Extension with MDM](https://docs.ox.security/ox-code/scanning/ox-ide-integrations/ox-ide-extension/deploying-the-ox-ide-extension-with-mdm.md)
- [OX IDE Plugin (JetBrains)](https://docs.ox.security/ox-code/scanning/ox-ide-integrations/ox-ide-plugin.md)
- [Generating IDE/CLI Integration key](https://docs.ox.security/ox-code/scanning/ox-ide-integrations/generating-ide-cli-integration-key.md)
- [OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1.md)
- [Installing OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1/installing-ox-cli.md)
- [Authenticating OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli.md)
- [Connect OX CLI with OAuth](https://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli/connect-ox-cli-with-oauth.md)
- [Connect OX CLI with VibeSec](https://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli/connect-ox-cli-with-vibesec.md)
- [Connect OX CLI with an API key](https://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli/connect-ox-cli-with-an-api-key.md)
- [Scanning code with OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1/scanning-code-with-ox-cli.md)
- [Scanning Code Manually with OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1/scanning-code-with-ox-cli/scanning-code-manually-with-ox-cli.md)
- [Integrate OX CLI with Git Hooks](https://docs.ox.security/ox-code/scanning/ox-cli-1/scanning-code-with-ox-cli/integrate-ox-cli-with-git-hooks.md)
- [Configuring OX CLI](https://docs.ox.security/ox-code/scanning/ox-cli-1/configuring-ox-cli.md)
- [OX Code Inventory](https://docs.ox.security/ox-code/ox-code-inventory.md)
- [Applications](https://docs.ox.security/ox-code/ox-code-inventory/applications.md)
- [Managing Applications](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications.md)
- [Business Priority](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications/business-priority.md)
- [Irrelevant Applications](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications/irrelevant-applications.md)
- [Application Tags](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications/application-tags.md)
- [Application Owners](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications/application-owners.md)
- [Application Scan Settings](https://docs.ox.security/ox-code/ox-code-inventory/applications/managing-applications/application-scan-settings.md)
- [Application Details](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details.md)
- [Application Details: Explore tab](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details/application-details-explore-tab.md)
- [Application Details: Owners & Activity tab](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details/application-details-owners-and-activity-tab.md)
- [Application Details: Containers tab](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details/application-details-containers-tab.md)
- [Application Details: Scan History tab](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details/application-details-scan-history-tab.md)
- [Application Details: More Info tab](https://docs.ox.security/ox-code/ox-code-inventory/applications/application-details/application-details-more-info-tab.md)
- [SBOM](https://docs.ox.security/ox-code/ox-code-inventory/sbom.md)
- [SBOM Library Details](https://docs.ox.security/ox-code/ox-code-inventory/sbom/sbom-library-details.md)
- [Artifact BOM](https://docs.ox.security/ox-code/ox-code-inventory/artifact-bom.md)
- [Pipeline Bill of Materials](https://docs.ox.security/ox-code/ox-code-inventory/artifact-bom/pipeline-bill-of-materials.md)
- [API BOM](https://docs.ox.security/ox-code/ox-code-inventory/api-bom.md)
- [SaaS BOM](https://docs.ox.security/ox-code/ox-code-inventory/saas-bom.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/ox-code.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.