Skip to content
NightVision Docs

Installing the CLI

Install the CLI

Section titled “Install the CLI”

First, download the NightVision Command Line Interface (CLI):

Max/Linux

Section titled “Max/Linux”
Homebrew (Mac/Linux)
# Install:
brew install nvsecurity/taps/nightvision


# Upgrade to the latest version:
brew update && brew upgrade nightvision
Mac (Intel)
curl -L https://downloads.nightvision.net/binaries/latest/nightvision_latest_darwin_amd64.tar.gz | tar -xz; mv nightvision /usr/local/bin/
Mac (ARM)
curl -L https://downloads.nightvision.net/binaries/latest/nightvision_latest_darwin_arm64.tar.gz -q | tar -xz; mv nightvision /usr/local/bin/

Linux

Section titled “Linux”
Intel
curl -L https://downloads.nightvision.net/binaries/latest/nightvision_latest_linux_amd64.tar.gz -q | tar -xz; sudo mv nightvision /usr/local/bin/
ARM
curl -L https://downloads.nightvision.net/binaries/latest/nightvision_latest_linux_arm64.tar.gz -q | tar -xz; sudo mv nightvision /usr/local/bin/
Windows Subsystem for Linux
Section titled “Windows Subsystem for Linux”

If you’re using Windows Subsystem for Linux (WSL), install xdg-utils as a prerequisite. This will allow the CLI to open the browser to perform the login command.

Terminal window
sudo apt install xdg-utils

Windows (PowerShell)

Section titled “Windows (PowerShell)”
  1. Launch PowerShell as an administrator.
    1. Click on the “Start” button located at the bottom-left corner of your screen or press the “Windows” key on your keyboard to open the Start Menu.
    2. In the search bar, type “PowerShell.” Right-click on “Windows PowerShell” in the search results.
    3. From the context menu that appears, select “Run as administrator.”
  2. Paste the commands below into your PowerShell terminal.
Windows (Intel)
# Open a new Admin Powershell console


# Create the folder and add the new location into the PATH for the first time only
New-Item -ItemType Directory -Path "C:\Program Files\Nightvision\bin" -Force
$env:Path = "$env:Path;C:\Program Files\Nightvision\bin"
[Environment]::SetEnvironmentVariable("Path", $env:Path, "Machine")


# Run this block to install or update the app
Invoke-WebRequest -Uri https://downloads.nightvision.net/binaries/latest/nightvision_latest_windows_amd64.tar.gz -OutFile nightvision_latest_windows_amd64.tar.gz
tar xf .\nightvision_latest_windows_amd64.tar.gz -C "C:\Program Files\Nightvision\bin"
rm .\nightvision_latest_windows_amd64.tar.gz
Windows (ARM)
# Open a new Admin Powershell console


# Create the folder and add the new location into the PATH for the first time only
New-Item -ItemType Directory -Path "C:\Program Files\Nightvision\bin" -Force
$env:Path = "$env:Path;C:\Program Files\Nightvision\bin"
[Environment]::SetEnvironmentVariable("Path", $env:Path, "Machine")


# Run this block to install or update the app
Invoke-WebRequest -Uri https://downloads.nightvision.net/binaries/latest/nightvision_latest_windows_arm64.tar.gz -OutFile nightvision_latest_windows_arm64.tar.gz
tar xf .\nightvision_latest_windows_arm64.tar.gz -C "C:\Program Files\Nightvision\bin"
rm .\nightvision_latest_windows_arm64.tar.gz

Help Page

Section titled “Help Page”

Append --help to any command to view usage information about the command or its subcommand.

Terminal window
# Root level command
nightvision --help


# Subcommand example
nightvision swagger extract --help

Authenticate the CLI

Section titled “Authenticate the CLI”

Run the following to authenticate the CLI with your NightVision account. Alternatively, nightvision will respect the NIGHTVISION_TOKENenvironment variable.

Terminal window
nightvision login
Section titled “Download Links”
OS/Architecture
Mac - Intel<https://downloads.nightvision.net/binaries/latest/nightvision_latest_darwin_amd64.tar.gz
Mac - Apple Silicon (ARM)<https://downloads.nightvision.net/binaries/latest/nightvision_latest_darwin_arm64.tar.gz
Linux - Intel<https://downloads.nightvision.net/binaries/latest/nightvision_latest_linux_amd64.tar.gz
Linux - ARM<https://downloads.nightvision.net/binaries/latest/nightvision_latest_linux_arm64.tar.gz
Windows - Intel<https://downloads.nightvision.net/binaries/latest/nightvision_latest_windows_amd64.tar.gz
Windows - ARM<https://downloads.nightvision.net/binaries/latest/nightvision_latest_windows_arm64.tar.gz

CLI Usage

Section titled “CLI Usage”

Learn more about other CLI commands in the pages below.

API Discovery API Discovery: swagger extract and swagger diff ▶ Create Web Targets Running Scans from the CLI: scan ▶ Recording Interactive Logins with Playwright Recording Interactive Logins with Playwright: auth playwright create ▶ Create Headers and Cookies Create Header Credentials: auth headers create ▶ export sarif command for Code Traceback Code Traceback: export sarif ▶ Web Targets: CLI Web Target Commands ▶ API Targets: CLI API Target Commands ▶

The command line uses NightVision’s Smart Proxy in the background to run fast scans against targets on private networks. It requires zero configuration on behalf of the customer for a transparent user experience. If you’re curious about how this works, you can view details about the Smart Proxy at the link below.

How the Smart Proxy Works in the background How the Smart Proxy Works in the background ▶