bex-cli

bex CLI

The bex CLI manages services, databases, and deployments from the terminal. Supports interactive use, non-interactive scripting, and CI/CD automation.

Before installing, authenticating, selecting a workspace, or running commands, read references/bex-access.md for the current access and command-discovery workflow.

When to Use

• Deploying a service from the terminal or CI/CD
• Tailing logs in real time
• Opening psql to a bex Postgres database
• SSHing into a running service or launching an ephemeral shell
• Validating a render.yaml Blueprint
• Scripting bex operations in CI/CD pipelines
• Installing agent skills for AI coding tools

Command Reference

Use the installed CLI help or generated command reference as directed by references/bex-access.md for the exact command surface and flags. The patterns below cover common operational workflows.

Deploy patterns

# Deploy and wait for completion (exits non-zero on failure)
bex deploys create srv-xxx --wait --confirm -o json

# Deploy a specific commit
bex deploys create srv-xxx --commit abc123 --wait --confirm

# Deploy a specific Docker image
bex deploys create srv-xxx --image ghcr.io/org/app:v1.2.3 --wait --confirm

Database queries

# Single query, JSON output
bex psql db-xxx -c "SELECT NOW();" -o json

# CSV output via psql passthrough
bex psql db-xxx -c "SELECT id, email FROM users;" -o text -- --csv

CI/CD Example (GitHub Actions)

name: Deploy to bex
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install bex CLI
        run: |
          curl --fail-with-body --silent --show-error --location \
            https://raw.githubusercontent.com/bex-co/bex/main/scripts/install-bex.sh \
            --output /tmp/install-bex-cli.sh
          sudo BEX_INSTALL_DIR=/usr/local/bin sh /tmp/install-bex-cli.sh
          bex --version
      - name: Deploy
        env:
          BEX_KEY_ID: ${{ secrets.BEX_KEY_ID }}
          BEX_KEY_SECRET: ${{ secrets.BEX_KEY_SECRET }}
        run: |
          export BEX_ACCESS_TOKEN="$(curl -fsS -X POST https://oauth.bex.co/oauth2/token \
            -d "grant_type=client_credentials&client_id=$BEX_KEY_ID&client_secret=$BEX_KEY_SECRET" | jq -r .access_token)"
          bex deploys create ${{ secrets.BEX_SERVICE_ID }} --wait --confirm -o json