> 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/vibesec/installing-vibesec.md).

# Installing VibeSec

## Installing VibeSec

Before developers can use VibeSec, you must install it on their development machines.

Choose the installation method based on how you plan to deploy VibeSec.

For manual installations on individual developer machines, OAuth is recommended. For centralized MDM or fleet deployments, API token authentication is recommended because it simplifies deployment and does not require developers to authenticate individually.

### Installation methods

| Method                                                                                                                         | Recommended for                                                                                                                                                                                            |
| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Single-device installation using OAuth](/vibesec/installing-vibesec/installing-vibesec.md)                                    | Manual installations on individual developer machines. This is the recommended method for individual installations.                                                                                        |
| [Single-device installation using API token](/vibesec/installing-vibesec/installing-vibesec-on-a-single-device-using-token.md) | Individual installations where OAuth cannot be used or token authentication is required.                                                                                                                   |
| [Organization-wide deployment](/vibesec/installing-vibesec/deploying-vibesec-across-the-organization.md)                       | Centralized MDM or fleet deployments, such as deployments using Jamf, Microsoft Intune, Kandji, or another device management solution. API token authentication is recommended for this deployment method. |
| [On-premises](/vibesec/installing-vibesec/installing-vibesec-on-premises.md)                                                   | Organizations using a self-hosted OX Security deployment.                                                                                                                                                  |

### Authentication methods

VibeSec supports OAuth and API token authentication. The recommended authentication method depends on how VibeSec is deployed.

| Authentication method | Description                                                                                                                                                                                                                                  |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth                 | Developers authenticate through their browser and sign in using their OX account. OAuth is recommended for manual installations on individual developer machines.                                                                            |
| API token             | VibeSec authenticates using a user-generated API token. API token authentication is recommended for MDM and fleet deployments because it enables centralized deployment without requiring each developer to complete an authentication flow. |

For on-premises deployments, OAuth is not supported. VibeSec authenticates using an OX API key.


---

# 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/vibesec/installing-vibesec.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.