CLI Installation & Setup Quickstart

This quickstart guide walks developers and system administrators through installing the Niksphere CLI (nik) and authenticating with Niksphere Cloud.

Prerequisites

Before starting, ensure you have:

• A working terminal environment (PowerShell on Windows, or Bash/Zsh on Linux/macOS).
• Network access to https://install.niksphere.de (for script installation) and https://my.niksphere.de (for Cloud authentication).

Step 1: Install Niksphere CLI

The Niksphere CLI (nik) can be installed using automated platform installation scripts.

For this quickstart, run the installation command for your operating system:

irm https://install.niksphere.de/install.ps1 | iex

curl -fsSL https://install.niksphere.de/install.sh | bash

curl -fsSL https://install.niksphere.de/install.sh | bash

Step 2: Connect to Niksphere Cloud

The Niksphere CLI (nik) connects to Niksphere Cloud to manage cloud tenants, regions, and remote engine environments.

For this quickstart, log in to your Cloud account:

nik cloud auth login

Verification

Verify that your Niksphere CLI installation and Cloud authentication are configured cleanly:

1. Verify CLI Version & System Info:

   nik self about

2. Verify Active Cloud Auth Status:

   nik cloud auth status

Expected Response:

Cloud Context: https://my.niksphere.de
Status: Authenticated
User: user@company.internal
Active Tenant: my-company-tenant

Uninstalling

To remove the Niksphere CLI (nik) from your system, run:

nik self uninstall

This stops any running nik processes, removes the binary, and cleans up the PATH entry created during installation.

Alternatively, you can run the uninstaller script directly, for example if nik is no longer on your PATH:

irm https://install.niksphere.de/uninstall.ps1 | iex

curl -fsSL https://install.niksphere.de/uninstall.sh | bash

curl -fsSL https://install.niksphere.de/uninstall.sh | bash

Restart your terminal afterwards so the PATH changes take effect.

Next Steps

• Engine Setup: Learn how to install and run a local Niksphere Engine in the Engine Installation & Setup Guide.
• CLI Reference: Explore the complete list of commands in the CLI Reference.