🔍 Search documentation... ⌘K

Getting Started

Deploy scalable cloud infrastructure in minutes. This guide walks you through installing the CloudNexus CLI, authenticating your account, and launching your first production-ready instance.

Prerequisites

💡 Pro Tip

Generate your API key in the Dashboard → Settings → API Keys. Store it securely using environment variables or a secrets manager. Never commit keys to version control.

Step 1: Install the CloudNexus CLI

The official CLI provides fast provisioning, monitoring, and configuration management directly from your terminal.

macOS & Linux 
curl -fsSL https://cli.cloudnexus.io/install.sh | bash
Windows (PowerShell) 
iwr -useb https://cli.cloudnexus.io/install.ps1 | iex

Verify the installation:

Verify 
cnx version
# Output: CloudNexus CLI v2.4.1 (build 892a4c)

Step 2: Authenticate

Initialize the CLI with your API key. The configuration is stored securely in ~/.cloudnexus/config.yaml.

Terminal 
cnx auth login
# Paste your API key when prompted
# ✅ Successfully authenticated as: dev-team@cloudnexus.io
🔑 Environment Variables

You can also authenticate headlessly for CI/CD pipelines by exporting CNX_API_KEY before running commands.

Step 3: Deploy Your First Instance

Create a production-ready VPS with a single command. CloudNexus automatically provisions networking, storage, and firewall rules.

Deploy 
cnx instance create \
  --name web-server-01 \
  --region us-east-1 \
  --type pro-4 \
  --image ubuntu-22.04 \
  --ssh-key my-key

Output:

Terminal 
⠋ Provisioning instance...
✅ Instance 'web-server-01' created successfully
   ID:       inst_9x82k4m2
   IP:       104.28.14.22
   Status:   booting (ready in ~30s)

Step 4: Verify & Monitor

Connect to your instance and verify metrics are flowing to the CloudNexus dashboard.

SSH & Metrics 
# Connect via SSH
cnx ssh web-server-01

# View real-time metrics locally
cnx monitor stream --instance web-server-01

# Open dashboard
cnx dashboard open --region us-east-1
⚠️ Security Note

By default, SSH (port 22) and HTTP/HTTPS (80/443) are open. Use cnx firewall create to restrict access to specific IPs for production workloads.

Next Steps

You're up and running! Continue with these recommended guides:

← Previous Overview
"}