cli
CLI Overview
Install and get started with the Runix command-line interface.
The Runix CLI lets you deploy, manage, and monitor your services directly from the terminal. Every action you can take in the dashboard is also available through the CLI.
Installation#
bash
brew install runix-dev/tap/runixVerify the installation by checking the version:
bash
$ runix --version
runix 0.1.0Quick Reference#
| Command | Description |
|---|---|
| `runix login` | Authenticate with Runix |
| `runix logout` | Remove stored credentials |
| `runix whoami` | Show current user info |
| `runix init` | Generate a runix.yaml template |
| `runix deploy` | Deploy services from runix.yaml |
| `runix status [name]` | Show deployment status |
| `runix logs <name>` | Stream logs from a deployment |
| `runix destroy <name>` | Delete a deployment |
| `runix env <action>` | Manage environment variables |
| `runix domains <action>` | Manage custom domains |
| `runix scale <name>` | Change instance type |
| `runix projects <action>` | Manage projects |
| `runix blueprints` | List available blueprints |
| `runix open [name]` | Open deployment in browser |
Global Flags#
| Flag | Environment Variable | Default | Description |
|---|---|---|---|
| `--api-url <URL>` | `RUNIX_API_URL` | `https://api.runix.dev` | Override the API base URL |
You can set RUNIX_API_URL in your shell profile so you don't need to pass --api-url every time.
Authentication#
Most commands require authentication. Run `runix login` first. Your credentials are stored locally and used automatically for subsequent commands.