Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

The Nexterm CLI (nt) lets you connect to your servers straight from the terminal — no browser needed. It uses the same authentication and server inventory as the Nexterm web UI, so every server, folder, identity, and tag you’ve already configured is immediately available from the command line. This is useful for quick SSH sessions, one-off remote commands, and scripting or CI pipelines that need to reach servers without a GUI.

Requirements

Building nt from source requires the Rust toolchain. Install it with:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Make sure cargo is on your $PATH after installation. Run cargo --version to confirm.

Build and install

1

Build the binary

From the root of the Nexterm repository, run:
cd cli && cargo build --release
The compiled binary is placed at cli/target/release/nt.
2

Move it to your PATH

Copy the binary to a directory that is already in your $PATH:
cp cli/target/release/nt /usr/local/bin/
Verify the installation:
nt --version
3

Log in to your server

Authenticate against your Nexterm instance:
nt login
You will be prompted for your server URL (for example, https://nexterm.example.com) and then asked how you want to authenticate:
  • Login with a code — a one-time code is displayed. Open the Nexterm web UI, go to Servers → Connect Device, and enter the code. The code expires in 10 minutes.
  • Login with browser — your default browser opens a pre-filled authorization page automatically.
Once authorized, your session token is saved locally and nt confirms the account you are logged in as.

Configuration file

After login, nt stores its configuration at:
~/.config/nexterm/config.json
This file holds your server URL, session token, and any other settings you configure with nt config. You can inspect it directly or manage it using the nt config commands.
If your Nexterm server uses a self-signed certificate, run nt config set accept-invalid-certs true after logging in to suppress TLS verification errors.

Next steps

CLI commands

Full reference for every nt command, flag, and usage example.

Nexterm web UI

Manage servers, folders, identities, and tags in the browser.

Build docs developers (and LLMs) love