Skip to content

Nexaa CLI

The Nexaa CLI is a command-line interface for managing your cloud resources on Nexaa.

Installation

Use the official install script for the easiest setup:

1
2
# Install the latest version
curl -sSL https://docs.nexaa.io/install.sh | bash

This script will automatically download and install the appropriate binary for your system.

Building from Source

If you prefer to build from source, you can clone our open source repository:

Prerequisites: - Go 1.23.0 or higher - Access to Nexaa platform credentials

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Clone the repository
git clone https://github.com/nexaa-cloud/nexaa-cli

# Navigate to directory
cd nexaa-cli

# Install dependencies
go mod vendor

# Build the binary
go build -o nexaa .

Shell Completion

Enable auto-completion for enhanced productivity:

1
2
3
4
5
6
7
8
9
# For Bash
source <(nexaa completion bash)

# For Zsh
source <(nexaa completion zsh)

# To persist, add to your shell configuration files
echo 'source <(nexaa completion bash)' >> ~/.bashrc  # For Bash
echo 'source <(nexaa completion zsh)' >> ~/.zshrc    # For Zsh

Getting Started

Before using the CLI, you need to authenticate with the Nexaa platform:

Note

You won't be able to login if you have 2FA enabled on your account. If you want to use the CLI, please use an user without 2FA enabled.

1
2
3
# Login with username and password
nexaa login --username your-username
# You'll be prompted to enter your password

Once authenticated, you can start managing your resources:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# Create a namespace to organize your resources
nexaa namespace create --name "my-namespace" --description "Production namespace"

# Deploy a serverless container
nexaa container create \
  --namespace "example-app" \
  --name "example-container" \
  --image "nginx" \
  --resources "CPU_250_RAM_500"

# Create a database cluster
nexaa databasecluster create \
  --namespace "example-app" \
  --name "example-db" \
  --type "PostgreSQL" \
  --version "16.4" \
  --plan "shared-1-cpu-4-gb-ram-1-node-EUR-Monthly"

Available Commands

The CLI provides the following main command groups:

Command Description
nexaa login Authenticate with the Nexaa platform
nexaa namespace Manage namespaces
nexaa container Manage serverless containers
nexaa container_job Manage container jobs
nexaa databasecluster Manage database clusters
nexaa volume Manage persistent storage volumes
nexaa registry Manage private container registries
nexaa resources List available resource configurations
nexaa version Show CLI version information
nexaa completion Generate shell completion scripts

For detailed help on any command, use the --help flag:

1
nexaa [command] --help