Skip to main content
The Convox CLI is a command-line tool for managing Convox racks, applications, and resources. Install it on your local machine to get started.

​
Installation

Choose your operating system to see installation instructions:

​
macOS Installation

1

Download the CLI

Download the latest Convox CLI binary for macOS Intel:
curl -L https://github.com/convox/convox/releases/latest/download/convox-macos -o /tmp/convox
2

Install to system path

Move the binary to your system path and make it executable:
sudo mv /tmp/convox /usr/local/bin/convox
sudo chmod 755 /usr/local/bin/convox
3

Verify installation

Confirm the CLI is installed correctly:
convox --version

​
Verify Installation

After installation, verify the CLI is working correctly: 
convox --version
Expected output: 
3.x.x
You can also view all available commands: 
convox --help

​
Authentication

If you’re using the Convox Web Console, you’ll need to authenticate the CLI:
1

Log in to Convox

Run the login command:
convox login
2

Enter your credentials

Follow the prompts to authenticate with your Convox account.
3

Verify authentication

List your racks to confirm authentication:
convox racks

​
Common Commands

Here are some essential Convox CLI commands: 
convox racks

​
Update the CLI

To update to the latest version of the Convox CLI, simply repeat the installation process. The new binary will replace the old one. 
# macOS Intel example
curl -L https://github.com/convox/convox/releases/latest/download/convox-macos -o /tmp/convox
sudo mv /tmp/convox /usr/local/bin/convox
sudo chmod 755 /usr/local/bin/convox
Check the Convox releases page to see what’s new in each version.

​
Troubleshooting

​
Permission denied

If you get a “permission denied” error when running convox: 
sudo chmod 755 /usr/local/bin/convox

​
Command not found

If you get “command not found”:
  1. Ensure /usr/local/bin is in your PATH: 
    echo $PATH
  2. If not, add it to your shell profile (~/.bashrc, ~/.zshrc, etc.): 
    export PATH="/usr/local/bin:$PATH"
  3. Reload your shell configuration: 
    source ~/.bashrc  # or ~/.zshrc

​
macOS security warning

On macOS, you may see a security warning about an unidentified developer:
  1. Go to System Preferences > Security & Privacy
  2. Click Allow Anyway next to the blocked message
  3. Run the convox command again

​
Next Steps

Development Rack

Install a local development rack

Production Rack

Deploy to your cloud provider

CLI Reference

View all CLI commands

Getting Started

Learn Convox fundamentals

Build docs developers (and LLMs) love

Get started for freeTalk to us