Install the CLI

Overview

The Oblax CLI (obx) is the command-center for managing projects, accounts, applications, and all platform interactions. It operates on a deterministic command grammar that ensures predictable, scriptable commands across all modules.

The CLI supports three installation methods: Homebrew for macOS/Linux, direct binary download for all platforms, and npm for Node.js environments. After installation, you can verify the installation and begin managing Oblax resources immediately.

Installation

Homebrew (macOS / Linux)

The recommended method for most developers.

brew tap oblax/tap && brew install obx

Binary Download (All Platforms)

If Homebrew isn’t available, you can grab a pre-built binary directly.

Download the archive for your platform and extract it:

curl -L -o obx.tar.gz https://oblax.io/cli/linux-amd64/obx.tar.gz
tar -xzf obx.tar.gz

On macOS, swap in the appropriate URL from the table above. On Windows, you’ll get an .exe directly — no extraction needed.

Next, make the binary executable and place it somewhere on your PATH. We recommend installing it under your home directory rather than system-wide — it avoids permission headaches and keeps things tidy:

chmod +x obx
mkdir -p ~/.local/bin
mv obx ~/.local/bin/obx

If ~/.local/bin isn’t already in your PATH, add it to your shell profile:

# bash — add to ~/.bashrc or ~/.bash_profile
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# zsh — add to ~/.zshrc
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# fish
fish_add_path ~/.local/bin

Tip: On most Linux distributions, ~/.local/bin is already in your default PATH, so you may only need to drop the binary in there.

npm (Node.js Environment)

If you’re already working in a Node.js environment, you can install the CLI as an npm package.

npm install -g @oblax/cli

Verify Installation

After installation, verify the CLI is working:

obx version

Expected output:

obx version 0.1.0

Troubleshooting