> 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/ox-code/scanning/ox-cli-1/installing-ox-cli.md). # Installing OX CLI The OX CLI lets you run OX security scans directly from the command line. This page explains how to install and maintain the CLI. After installation, continue to [OX CLI authentication](/ox-code/scanning/ox-cli-1/authenticating-ox-cli.md). ## Prerequisites Before you begin the installation process, make sure the following tools are installed: * [Node.js](https://nodejs.org/), version 16 and newer * npm * [Git](https://git-scm.com/downloads) ## Installing OX CLI The CLI installation method is for users installing from the public npm registry. **To install OX CLI:** ```bash npm install -g @oxappsec/ox-cli ``` ### Verifying successful installation To verify that the CLI is working, run `ox-cli --version`. The available commands, options, and the current version appear.
### Updating OX CLI **To update OX CLI, update public NPM builds:** * Run: ``` ox-cli update ``` **To verify the update in both distributions:** ```bash ox-cli --version ``` ### Uninstalling OX CLI **To uninstall OX CLI, run:** ```bash npm uninstall -g @oxappsec/ox-cli ``` --- # 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/ox-code/scanning/ox-cli-1/installing-ox-cli.md?ask=&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.