Docs / Getting Started / Quickstart Guide

Quickstart Guide

Deploy your first cloud instance in under 5 minutes. Learn how to authenticate, configure your environment, and launch a production-ready server.

1. Installation

The CloudNexus CLI is the primary tool for managing your infrastructure. Install it via npm, pip, or download a native binary.

bash
# Using npm (Node.js) npm install -g @cloudnexus/cli # Using pip (Python) pip install cloudnexus-cli # macOS via Homebrew brew install cloudnexus/tap/cnx
ℹī¸ Prerequisites

Ensure you have Node.js 18+, Python 3.9+, or a compatible shell environment. Docker is required for local preview environments.

2. Configure Environment

Authenticate your CLI by running the setup command. This will open a browser window for OAuth2 authorization and securely store your credentials.

bash
cnx auth login # Follow the browser prompt to select your account # Credentials saved to ~/.cnx/config.json

Configure your default region and project:

bash
cnx config set region us-east-1 cnx config set project my-production-app cnx config list

3. Deploy Your First Instance

Create a new compute instance with our declarative YAML configuration:

YAML (deploy.yaml)
apiVersion: cnx.io/v1 kind: ComputeInstance metadata: name: web-server-01 labels: environment: production spec: type: cnx-g4-standard os: ubuntu-22.04 vcpu: 4 memory: 16 # GB storage: 100 # NVMe SSD network: subnet: private-a firewall: [web-tier] autoScaling: true
bash
cnx deploy apply -f deploy.yaml # ✔ Instance provisioning: 12s # ✔ Security groups applied # ✔ Health checks passing # Instance web-server-01 is ready at 10.0.4.22
✅ Deployment Successful

Your instance is now live and accessible. Monitor resource utilization in the dashboard or via cnx monitor watch.

4. Regional Availability

CloudNexus operates across 50+ global regions. Select the closest region to your target audience for optimal latency.

Region Code AZs Latency (Avg)
US East (Virginia) us-east-1 3 12ms
EU West (Ireland) eu-west-1 3 18ms
Asia Pacific (Tokyo) ap-northeast-1 2 24ms
South America (SÃŖo Paulo) sa-east-1 2 32ms
⚠ī¸ Data Residency Compliance

For GDPR and HIPAA workloads, ensure all instances and storage buckets are provisioned within EU or US regions respectively. Cross-region replication requires explicit enablement.

Next Steps