> 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/agent-guidelines/checking-vibesec-status-on-the-client-end.md).

# Checking VibeSec Status on the Client End

## Checking VibeSec status

You can verify that VibeSec is active and view the security guidelines applied to your current AI coding session with the `/ox-vibesec-status` command.

The command checks the VibeSec configuration and activity on your local machine. It does not contact OX.

> **Note** The `/ox-vibesec-status` command is currently available in Claude Code only. It is automatically included when you install VibeSec.

**To check the VibeSec status in your current Claude Code session:**

1. Open a Claude Code session.
2. Run:

   ```
   /ox-vibesec-status
   ```
3. Review the returned status. For example:

   ```
   OX Security - VibeSec: ACTIVE ✅

     Authentication:      valid ✅
     Hooks registered:    yes ✅
     Last OX API call:    succeeded ✅ (9/7/2026, 10:14:03 AM)

     Organization:        Acme Corp (org_123abc)
     OX VibeSec version:  1.0.109
     Node runtime:        v22.14.0

   Guidelines active in the current session (2):
     • SQL Injection Prevention (gl_sqli_java) — 3.2 KB
     • XSS Prevention (gl_xss_js) — 2.8 KB
   ```

   The report includes the following information:

   | Field                                    | Description                                                                                                                                                                                                                              |
   | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Status                                   | Indicates whether VibeSec is `ACTIVE` or `INACTIVE`. VibeSec is active when authentication is valid, hooks are registered, and the most recent OX API call did not fail. A new installation can show `ACTIVE` before the first API call. |
   | Authentication                           | Indicates whether a valid OX token is available on the machine. `missing or expired` indicates that you need to reinstall VibeSec or re-authenticate.                                                                                    |
   | Hooks registered                         | Indicates whether the hooks that trigger VibeSec are registered in the Claude Code settings.                                                                                                                                             |
   | Last OX API call                         | Shows the result and time of the most recent prompt analysis. `none yet` is displayed after a new installation until you submit your first prompt.                                                                                       |
   | Organization                             | Shows the OX organization associated with the authenticated user. This field is not displayed when VibeSec authenticates using an API token.                                                                                             |
   | OX VibeSec version                       | Shows the VibeSec version installed on the machine.                                                                                                                                                                                      |
   | Node runtime                             | Shows the Node.js version used to run VibeSec.                                                                                                                                                                                           |
   | Guidelines active in the current session | Lists the security guidelines that OX provided for the current Claude Code session and the size of each guideline. `none fetched yet` is displayed until you submit a coding prompt in the session.                                      |
4. If no guidelines are listed, submit a coding prompt in the current session.

   VibeSec retrieves the relevant security guidelines from OX and makes them available to the agent.
5. Run `/ox-vibesec-status` again to view the guidelines active in the current session.

### Troubleshooting

| Report shows                                                 | What to do                                                                                                                                  |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `Authentication: missing or expired ❌`                       | Run the VibeSec installer again to authenticate. See Installing VibeSec.                                                                    |
| `Hooks registered: no ❌`                                     | Run the VibeSec installer again, and then restart Claude Code.                                                                              |
| `Last OX API call: failed ❌`                                 | Check that the machine can access `api.cloud.ox.security`. If your organization uses a proxy, reinstall VibeSec using the `--proxy` option. |
| `Guidelines active in the current session: none fetched yet` | Submit a coding prompt in the current session, and then run `/ox-vibesec-status` again.                                                     |


---

# 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/agent-guidelines/checking-vibesec-status-on-the-client-end.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.
