> 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/configuring-ox-cli.md).

# Configuring OX CLI

Configure the OX CLI to match your environment and preferences. Use the CLI configuration commands to view or update settings, configure a custom OX API endpoint, enable or disable telemetry, or use environment variables to override configuration values.

### View the current configuration

To display the current value of a configuration parameter, run:

```bash
ox-cli config get <parameter>
```

To list all available configuration parameters, run:

```bash
ox-cli config get
```

### Configure the OX API endpoint

By default, the OX CLI connects to the OX Cloud API endpoint.

If you're connecting to a different environment, such as a staging or development environment, configure a custom API endpoint:

```bash
ox-cli config set api-host https://custom.api.endpoint.com
```

### Configure telemetry

The OX CLI can send anonymous usage data to help improve the product.

Enable telemetry:

```bash
ox-cli config set telemetry true
```

Disable telemetry:

```bash
ox-cli config set telemetry false
```

### Use environment variables

You can configure the OX CLI by using environment variables instead of storing configuration values locally. Environment variables are useful for temporary sessions, scripts, and CI/CD pipelines.

The following environment variables are supported:

| Environment variable | Description                      |
| -------------------- | -------------------------------- |
| `OX_API_KEY`         | API key used for authentication. |
| `OX_API_HOST`        | OX API endpoint.                 |
| `OX_TELEMETRY`       | Enables or disables telemetry.   |

Environment variables override locally stored configuration values for the current session.

> **Note**
>
> Environment variables are intended for temporary or automated environments. For interactive use, configure the CLI using the `ox-cli config` commands.


---

# 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/configuring-ox-cli.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.