getting started

Install the Runix CLI

Install and set up the Runix command-line tool to deploy from your terminal.

The Runix CLI is a small command-line tool that lets you deploy, manage, and monitor your apps directly from your terminal. It's optional — you can do everything from the dashboard — but most developers find it faster.

Installation#

Quick Install (macOS & Linux)#

Run this single command in your terminal. It downloads the latest version of the Runix CLI and installs it on your system.

bash

curl -fsSL https://runixcloud.dev/install.sh | sh

The install script detects your operating system and CPU architecture automatically. It works on macOS (Intel and Apple Silicon) and Linux (x64 and ARM).

Other Installation Methods#

bash

curl -fsSL https://runixcloud.dev/install.sh | sh

Windows#

The Runix CLI runs on macOS and Linux. On Windows, use WSL (Windows Subsystem for Linux) and then run the curl install command above inside your WSL terminal.

Verify Installation#

After installing, make sure it worked by checking the version:

bash

runix --version
# Output: runix 0.1.0

If you see a version number, you're all set. If you get a "command not found" error, try opening a new terminal window or check that the install path is in your system PATH.

Authenticating#

Before you can deploy, you need to connect the CLI to your Runix account. There are two ways to do this.

This opens your default browser where you can sign in with GitHub or email. After you log in, the CLI is automatically authenticated.

bash

runix login

Expected output

text

Opening browser for authentication...
Waiting for login...
Logged in as yourname@example.com

If you're on a remote server or prefer not to open a browser, log in with your email and password directly in the terminal.

bash

runix login --email

Expected output

text

Email: yourname@example.com
Password: ********
Logged in as yourname@example.com

Where Credentials Are Stored#

Your login credentials (an authentication token) are stored locally on your machine at:

text

~/.config/runix/

This directory contains your auth token and CLI preferences. You don't need to edit these files directly — the CLI manages them for you.

Don't share or commit the files in ~/.config/runix/ — they contain your authentication token. If you think your token has been compromised, run 'runix logout' and then 'runix login' to get a new one.

Updating the CLI#

To update to the latest version, just re-run the install script. It will replace the existing binary with the newest release.

bash

curl -fsSL https://runixcloud.dev/install.sh | sh

The CLI will let you know when a new version is available. You'll see a message after running any command when an update is ready.

Uninstalling#

To remove the Runix CLI from your system:

bash

# Remove the binary
rm $(which runix)

# Remove configuration and credentials
rm -rf ~/.config/runix/

Account Setup

Node.js