> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://dotnet.microsoft.com/download)
* A **Nexudus account** with API access

## Install the CLI

Install the CLI as a .NET global tool:

```bash theme={null}
dotnet tool install --global Nexudus.Cli
```

To update to the latest version:

```bash theme={null}
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`:

```bash theme={null}
echo 'export PATH="$PATH:$HOME/.dotnet/tools"' >> ~/.zshrc
source ~/.zshrc
```

## Verify the installation

Run the help command to confirm the CLI is available:

```bash theme={null}
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:

```bash theme={null}
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              |

<Tip>
  If `doctor` reports that credentials are missing, run `nexudus login` to authenticate. See [Authentication](/cli/authentication) for details.
</Tip>

## Configuration

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

```bash theme={null}
# 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:

```bash theme={null}
dotnet tool uninstall --global Nexudus.Cli
```

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/cli/authentication">
    Log in and manage your credentials.
  </Card>

  <Card title="CLI Commands" icon="list" href="/cli/commands">
    Explore the full command reference.
  </Card>
</CardGroup>