The Rulebricks CLI is a management utility that automates the creation and maintenance of private Rulebricks clusters, helping you deploy Rulebricks in customizable, high-throughput configurations on AWS, GCP, or Azure.

You can choose how much you would like the CLI to automate for you– use it to generate valid configuration values, automate infrastructure provisioning (via Terraform), software deployment (via Helm), or all of the above.

Installation

npm install -g @rulebricks/cli

Prerequisites

You must have a valid Rulebricks license key to deploy using this CLI. You will be requested for this key during project configuration.

Rulebricks requires TLS. You will require either external-dns on your cluster to automatically add DNS records, or you will need access to manually add DNS records for the subdomain(s) where you would like to access your private deployment from.

Finally, you will need to have the following tools installed and ready on your machine:

• Node.js >= 20
• kubectl - Kubernetes CLI
• Helm >= 3.0
• Terraform >= 1.0 (for infrastructure provisioning)
• Cloud CLI (aws, gcloud, or az) configured for your provider

Cluster Setup

If you want to create the Kubernetes cluster yourself, use the resources in cluster-setup/ before running the CLI wizard. These files provide minimum compatible AWS, Azure, and GCP cluster setup guidance plus optional access checks. Monitoring destinations are configured later by the CLI wizard and Helm values, not by these cluster setup files.

# AWS: optional access check, then create EKS with eksctl
AWS_REGION=us-east-1 bash cluster-setup/aws/check-aws-access.sh
cd cluster-setup/aws && eksctl create cluster -f cluster.yaml

# Azure: optional access check, then deploy AKS with Bicep
az login
az account set --subscription <subscription-id>
AZURE_LOCATION=eastus bash cluster-setup/azure/check-aks-prereqs.sh
az group create --name rulebricks-rg --location eastus
az deployment group create \
  --resource-group rulebricks-rg \
  --template-file cluster-setup/azure/main.bicep \
  --parameters @cluster-setup/azure/main.parameters.json

# GCP: optional access check, then create GKE with gcloud
GCP_REGION=us-central1 bash cluster-setup/gcp/check-gke-prereqs.sh
# Follow cluster-setup/gcp/README.md for the gcloud create commands.

After the cluster exists, update kubeconfig, then run rulebricks init and choose Use existing Kubernetes cluster. The existing Terraform provisioning path remains available, but native cloud setup is the clearest path when you want to own the cluster directly.

Quick Start

# Configuration wizard (generates values.yaml)
rulebricks init

# Provision and/or deploy to your cluster
rulebricks deploy my-deployment

Main Commands

| Command | Description | | --------------------------- | -------------------------------------- | | rulebricks init | Interactive setup wizard | | rulebricks deploy [name] | Deploy to Kubernetes | | rulebricks upgrade [name] | Upgrade to a new version | | rulebricks destroy [name] | Remove a deployment | | rulebricks status [name] | Show deployment health | | rulebricks logs [name] | Inspect services | | rulebricks open [name] | Open the generated configuration files |

Use rulebricks -h to explore all commands, and add -h to any command to learn more about a particular command's options.

Notes

There are a uniquely wide variety of customization options this CLI makes available (multi-cloud, hybrid vs. self-hosted database deployment, custom email templates, etc.), and not all combinations have been validated.

If you encounter any issue deploying your private Rulebricks cluster, please email us or open an issue and we will follow up promptly. If you are particularly familiar with helm/k8s, you are also free to review generated values.yaml files and reconcile them with our Helm chart.