Skip to main content
Documentation

Nexigon CLI

Nexigon CLI manages Nexigon Hub resources from a workstation or automation job. It can also forward device ports to your local machine for SSH and other network services.

Installation and Setup

Download Nexigon CLI 0.6.1 for your platform:

For checksums and other builds, see Nexigon CLI releases.

On Linux and macOS, make the downloaded binary executable:

chmod +x nexigon-cli

The examples below run it from the download directory as ./nexigon-cli. On Windows, use .\nexigon-cli.exe. You can also place the binary in a directory on your PATH and run it as nexigon-cli.

Configure Nexigon CLI

Create a user access token in the web interface. Nexigon CLI 0.6 and later also accept an organization API token, whose access is restricted by its policy.

Run:

./nexigon-cli configure

Enter your Nexigon Hub URL and API token. The command saves them to ~/.nexigon/cli.toml:

~/.nexigon/cli.toml
hub-url = "https://eu.nexigon.cloud/"
token = "u_sk_..."

Keep this file private because it contains the token.

Select a Configuration File

An explicit --config path takes precedence. Otherwise, Nexigon CLI uses .nexigon-cli.toml in its current working directory if present, followed by ~/.nexigon/cli.toml.

Run ./nexigon-cli configure --local to save a configuration in the current directory. If this directory is a Git repository, add .nexigon-cli.toml to .gitignore to keep the token out of commits. Without --local, configure updates the global file even when a local configuration takes precedence.

For an explicitly selected configuration:

./nexigon-cli --config ./production-cli.toml projects list

Publish Package Versions

Follow Publish a Package Version to create a release, upload and attach several files, add tags, and verify a download. The guide also shows how to read IDs from Nexigon CLI’s JSON responses.

Port Forwarding

Follow Establish a Remote Connection for SSH, local HTTP forwarding, multiple ports, browser URLs, and troubleshooting.

Command Help

Run ./nexigon-cli --help to list command groups, or append --help to a subcommand for its arguments.