Installing the Nexudus CLI

How to install the Nexudus CLI tool and verify that it’s working correctly.

Installing the Nexudus CLI

The Nexudus CLI is a .NET global tool. You need the .NET SDK installed on your machine before installing the CLI.

Prerequisites

• .NET 10 SDK or later — Download .NET
• A Nexudus account with API access

Install the CLI

Install the CLI as a .NET global tool:

dotnet tool install --global Nexudus.Cli

To update to the latest version:

dotnet tool update --global Nexudus.Cli

macOS (zsh)

If you use zsh (the default shell on macOS), you may need to add the .NET tools directory to your PATH:

echo 'export PATH="$PATH:$HOME/.dotnet/tools"' >> ~/.zshrc
source ~/.zshrc

Verify the installation

Run the help command to confirm the CLI is available:

nexudus --help

You should see the top-level command tree listing available commands such as login, logout, whoami, doctor, businesses, products, and more.

Run diagnostics

The doctor command checks your environment and confirms everything is set up correctly:

nexudus doctor

This reports:

Check	What it verifies
CLI version	The installed version of the Nexudus CLI
.NET runtime	The .NET runtime version on your machine
OS	Your operating system
Credentials stored	Whether you have saved login credentials
Config file	Location of the CLI configuration file
API connectivity	Whether the Nexudus API is reachable
Available commands	All registered CLI commands

If doctor reports that credentials are missing, run nexudus login to authenticate. See Authentication for details.

Configuration

The CLI stores its configuration in ~/.nexudus/config.json. You can view and change settings with:

# View a setting
nexudus config get base-url

# Change the API base URL (useful for testing)
nexudus config set base-url https://spaces.nexudus.com

The default base URL is https://spaces.nexudus.com.

Uninstall

To remove the CLI:

dotnet tool uninstall --global Nexudus.Cli

Next steps

Authentication

Log in and manage your credentials.

CLI Commands

Explore the full command reference.