Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/brimblehq/rexec/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick Install

The fastest way to install the Rexec CLI is using the installation script: 
curl -fsSL https://rexec.pipeops.io/install-cli.sh | bash
This script automatically:
  • Detects your platform (Linux, macOS, Windows)
  • Downloads the correct binary for your architecture (amd64/arm64)
  • Installs to /usr/local/bin
  • Verifies the installation

​
Platform Support

The CLI supports the following platforms:
OSArchitectureBinary Name
Linuxx86_64 (amd64)rexec-cli-linux-amd64
LinuxARM64 (aarch64)rexec-cli-linux-arm64
macOSIntel (amd64)rexec-cli-darwin-amd64
macOSApple Silicon (arm64)rexec-cli-darwin-arm64

​
Manual Installation

​
Download from Releases

  1. Visit the GitHub releases page
  2. Download the binary for your platform: 
    # Linux (amd64)
wget https://github.com/brimblehq/rexec/releases/latest/download/rexec-cli-linux-amd64

# macOS (Apple Silicon)
wget https://github.com/brimblehq/rexec/releases/latest/download/rexec-cli-darwin-arm64
  3. Make it executable and move to your PATH: 
    chmod +x rexec-cli-*
sudo mv rexec-cli-* /usr/local/bin/rexec
  4. Verify installation: 
    rexec version

​
Download from Rexec API

Binaries are also hosted directly on the Rexec platform: 
# Download for your platform
curl -fsSL https://rexec.pipeops.io/downloads/rexec-cli-linux-amd64 -o rexec
chmod +x rexec
sudo mv rexec /usr/local/bin/

​
Build from Source

Requires Go 1.21 or later.

​
Prerequisites

# Check Go version
go version
# Should output: go version go1.21.0 or higher

​
Clone and Build

# Clone the repository
git clone https://github.com/brimblehq/rexec.git
cd rexec

# Install dependencies
make deps

# Build the CLI
make cli

# Binary will be in bin/rexec-cli
./bin/rexec-cli version

# Install to system
sudo mv bin/rexec-cli /usr/local/bin/rexec

​
Build for All Platforms

To build binaries for all supported platforms: 
make cli-all-platforms
This creates binaries in the downloads/ directory:
  • rexec-cli-linux-amd64
  • rexec-cli-linux-arm64
  • rexec-cli-darwin-amd64
  • rexec-cli-darwin-arm64

​
Configuration

After installation, the CLI stores configuration in ~/.rexec/config.json: 
{
  "host": "https://rexec.pipeops.io",
  "token": "your-auth-token",
  "username": "your-username",
  "email": "user@example.com",
  "tier": "free"
}

​
Environment Variables

You can override configuration with environment variables: 
export REXEC_HOST="https://rexec.pipeops.io"
export REXEC_TOKEN="rexec_your_token_here"
Environment variables take precedence over the config file.

​
Verify Installation

Check that the CLI is correctly installed: 
# Check version and platform
rexec version

# Output:
# rexec-cli v1.0.0
# OS: linux/amd64

​
Next Steps

Authentication

Login and authenticate with Rexec

CLI Commands

Learn all available commands

​
Troubleshooting

​
Command Not Found

If you get command not found: rexec, ensure /usr/local/bin is in your PATH: 
echo $PATH
# Should include /usr/local/bin

# Add to PATH (bash)
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Add to PATH (zsh)
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

​
Permission Denied

If the binary isn’t executable: 
chmod +x /usr/local/bin/rexec

​
Binary Not Available for Download

If pre-built binaries aren’t available for your platform, you’ll need to build from source.

Build docs developers (and LLMs) love

Get started for freeTalk to us