🔍 Ctrl+K
API Reference Open Dashboard

Quick Start Guide

Deploy your first application on CloudNexus in under 5 minutes. This guide walks you through installation, authentication, and launching a production-ready instance.

💡
Prerequisites Make sure you have Node.js 18+ or Python 3.9+ installed, and a CloudNexus account with a valid API key.

1. Install the CLI

The CloudNexus CLI is the fastest way to provision and manage infrastructure. Install it using npm or your preferred package manager:

bash
# Using npm
npm install -g @cloudnexus/cli

# Verify installation
cx --version

2. Authenticate

Log in to your CloudNexus account using your API key. You can generate one from the Dashboard → API Keys settings.

bash
cx auth login --key "your_api_key_here"
🔒
Security Notice Never commit API keys to version control. Use environment variables or secret managers in production workflows.

3. Initialize a Project

Create a new project directory and initialize it with CloudNexus configuration:

bash
mkdir my-app && cd my-app
cx init

This generates a cloudnexus.yaml file with default configuration for regions, scaling policies, and networking.

4. Deploy

Push your configuration and spin up the infrastructure. The CLI handles provisioning, networking, and initial bootstrapping automatically.

bash
cx deploy --env production --region us-east-1

Once complete, you'll receive a dashboard URL, instance status, and public endpoints. You can monitor real-time metrics using:

bash
cx logs --follow --service web-server

5. Verify & Scale

Test your deployment by hitting the provided endpoint. To scale horizontally, update your configuration or run:

bash
cx scale --min 2 --max 10 --target-cpu 75