Docs › Getting Started › Quickstart

Quickstart Guide

Deploy your first application on CloudNexus in under 5 minutes. Follow the steps below to install the CLI, authenticate, and launch a production-ready instance.

1

Prerequisites

Before getting started, ensure you have the following:

  • An active CloudNexus account with an API key
  • Node.js 18+ or a Dockerized application ready
  • Git CLI installed
💡
Tip

New to CloudNexus? Create a free account to get $200 in credits and full access to the developer tier.

2

Install the CloudNexus CLI

We provide a unified CLI for managing your infrastructure. Install it using your preferred package manager:

bash
brew install cloudnexus/tap/cx-cli # or via npm npm install -g @cloudnexus/cli # or via curl curl -fsSL https://cli.cloudnexus.dev/install.sh | sh

Verify the installation:

bash
cx version CloudNexus CLI v4.2.1 (build 20250512)
3

Authenticate & Configure

Log in using your API key or OAuth session. We recommend using environment variables for CI/CD pipelines.

bash
export CX_API_KEY="cn_live_sk_xxxxxxxxxxxxxxxxxxxxxxxx" cx login ✓ Successfully authenticated as dev@example.com Region: us-east-1 (default)
4

Deploy Your Application

Initialize a new project and deploy with a single command. CloudNexus auto-detects your framework and generates an optimized production config.

bash
cd /path/to/your/app cx init --region eu-west-1 cx deploy ⠋ Building optimized container... ⠙ Provisioning network & SSL... ⠹ Deploying to eu-west-1... ✓ Live at: https://app-7x9m2.cloudnexus.io Instances: 2 (auto-scaling enabled)
⚠️
Production Notice

Default deployments include automatic DDoS protection and SSL. For custom domains, run cx dns link after deployment.

5

Verify & Monitor

Your application is now live. Use the CLI to check logs, metrics, and scale resources on demand.

bash
# View real-time logs cx logs tail # Check resource usage cx status # Scale horizontally cx scale --replicas 4 ✓ Scaling cluster to 4 replicas across 2 availability zones...
1

Log in to the CloudNexus Console

Navigate to console.cloudnexus.dev and sign in with your account credentials or SSO provider.

2

Create a New Project

Click "New Project" → "Compute". Select your preferred region and runtime (Node, Python, Docker, or Go).

3

Connect Repository & Deploy

Link your GitHub, GitLab, or Bitbucket repository. CloudNexus will automatically build and deploy on every push to main.

ℹ️
Console Limitations

For advanced networking, custom domains, and IaC workflows, the CLI or API is recommended.

1

Obtain Your API Key

Generate a programmatic key from Settings → API Keys with "Deploy" and "Read" scopes.

2

Create a Deployment

Use the REST API to provision infrastructure directly. Here's an example using cURL:

bash
curl -X POST https://api.cloudnexus.dev/v1/deployments \ -H "Authorization: Bearer cn_live_sk_..." \ -H "Content-Type: application/json" \ -d '{ "region": "us-east-1", "source": "https://github.com/org/repo", "branch": "main", "env": { "NODE_ENV": "production" } }'

What's Next?

Now that your application is live, explore advanced configurations and integrations.

🌐 Custom Domains & SSL

Connect your own domain with automatic HTTPS provisioning and CDN routing.

🗄️ Managed Databases

Spin up PostgreSQL, MySQL, or Redis with automated backups and failover.

📊 Observability

Set up distributed tracing, metrics, and alerting with CloudNexus Insights.

🔐 Security & IAM

Configure role-based access, firewall rules, and compliance guardrails.