📦 Installation Guide
Get the CloudNexus CLI up and running in under 2 minutes. Manage infrastructure, deploy services, and monitor clusters from your terminal.
Prerequisites
Before installing the CloudNexus CLI, ensure your system meets the following requirements:
- Operating System: macOS 11+, Ubuntu 20.04+, or Windows 10+ (WSL2 recommended)
- Runtime: Node.js 18.x or higher
- Account: A valid CloudNexus account (free tier available)
- Network: Stable internet connection for package downloads
Not sure about your Node.js version? Run
node -v in your terminal. We recommend using nvm to manage multiple Node versions.
Installation Methods
Choose the package manager or installer that best fits your workflow:
bash
# Install globally using npm
npm install -g @cloudnexus/cli
# Verify installation
cloudnexus --version
bash
# Install globally using yarn
yarn global add @cloudnexus/cli
# Verify installation
cloudnexus --version
bash
# Install globally using pnpm
pnpm add -g @cloudnexus/cli
# Verify installation
cloudnexus --version
bash
# Install via Homebrew (macOS/Linux)
brew tap cloudnexus/tap
brew install cloudnexus-cli
# Verify installation
cloudnexus --version
bash
# Download standalone binary (no Node.js required)
curl -fsSL https://cli.cloudnexus.dev/install | sh
# Add to PATH
export PATH="$HOME/.cloudnexus/bin:$PATH"
# Verify installation
cloudnexus --versionVerify Installation
After installation, confirm the CLI is working correctly:
bash
# Check CLI version
cloudnexus --version
# Output: @cloudnexus/cli/2.4.0
# List available commands
cloudnexus --help
# Check system status & connectivity
cloudnexus doctor
The
cloudnexus doctor command validates your environment, checks API connectivity, and recommends fixes if any issues are detected.
Authentication
Configure your credentials to interact with the CloudNexus API:
1
Initialize Login
Run cloudnexus auth login to open an interactive browser prompt.
2
Authorize in Browser
Sign in to your CloudNexus account and grant CLI access to your projects.
3
Verify Connection
Run cloudnexus auth whoami to confirm successful authentication.
bash
# Interactive login (recommended)
cloudnexus auth login
# Or use an API key directly (CI/CD)
cloudnexus auth login --token "$CLOUDNEXUS_API_KEY"
# Check current profile
cloudnexus auth whoamiWhat's Next?
Now that the CLI is installed and authenticated, explore these guides to get the most out of CloudNexus: