For the complete documentation index, see llms.txt. This page is also available as Markdown.

OX CLI

The OX CLI lets you run OX security scans directly from the command line. It helps you identify security issues early in the development process by scanning your code before committing changes or as part of your development workflow.

With the OX CLI, you can:

  • Scan code on demand from the command line.

  • Automatically scan code before committing or pushing changes by using Git hooks.

  • Focus scans on specific security categories.

  • Configure the CLI to match your environment and workflow.

Typical workflow

Use the following workflow to get started with the OX CLI:

Step
Description

Install the CLI, verify the installation, and keep it up to date.

Choose and configure the authentication method that best fits your workflow.

Choose between manual scans and Git hook integration based on your development workflow.

Customize CLI settings, such as the API endpoint, telemetry, and environment variables.

Last updated