> 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/scan-and-analyze-with-ox/scanning/ox-cli-1.md).

# 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                                                                              |
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [**1. Install OX CLI**](/scan-and-analyze-with-ox/scanning/ox-cli-1/installing-ox-cli.md)                | Install the CLI, verify the installation, and keep it up to date.                        |
| [**2. Authenticate OX CLI**](/scan-and-analyze-with-ox/scanning/ox-cli-1/authenticating-ox-cli.md)       | Choose and configure the authentication method that best fits your workflow.             |
| [**3. Scan code with OX CLI**](/scan-and-analyze-with-ox/scanning/ox-cli-1/scanning-code-with-ox-cli.md) | Choose between manual scans and Git hook integration based on your development workflow. |
| [**4. Configure OX CLI (Optional)**](/scan-and-analyze-with-ox/scanning/ox-cli-1/configuring-ox-cli.md)  | Customize CLI settings, such as the API endpoint, telemetry, and environment variables.  |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ox.security/scan-and-analyze-with-ox/scanning/ox-cli-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.