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.

Prerequisites

Before you begin the installation process, make sure the following tools are installed:

• Node.js, version 16 and newer

• npm

• Git

Installing OX CLI

The CLI installation method is for users installing from the public npm registry.

To install OX CLI:

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:

ox-cli --version

Uninstalling OX CLI

To uninstall OX CLI, run:

npm uninstall -g @oxappsec/ox-cli