CI/CD & Coding Agents

qumod runs unattended in CI pipelines and from coding agents: it never prompts without a terminal, and --json gives machine-readable output.

Exit Codes

qumod exits with one of three codes:

Exit Code	Meaning	Agent Strategy
`0`	Success	Parse stdout if `--json` was supplied.
`1`	API or Runtime Error	Authentication failure, missing resources, or control plane error. With `--json`, stderr carries `{"success": false, "error": "..."}`.
`2`	Usage / Argument Error	Invalid flags, missing required positional arguments, or unknown subcommands.

GitHub Actions Integration

Use this recipe to check the token and make sure a project exists in a GitHub Actions workflow. Store a personal access token (qumo_pat_…) as the QUMO_API_TOKEN secret.

.github/workflows/qumo.yml

name: Qumo

on:
  push:
    branches: [ main ]

jobs:
  qumo:
    name: Qumo project
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Install qumod CLI
        env:
          QUMOD_VERSION: "0.261108.0"
        run: |
          # Verifies the binary against the release's SHA256SUMS before installing.
          curl -fsSL https://dl.qumo-deploy.com/qumod/install.sh | sh
          echo "$HOME/.qumod/bin" >> "$GITHUB_PATH"

      - name: Verify CLI Authentication
        env:
          QUMO_TOKEN: ${{ secrets.QUMO_API_TOKEN }}
        run: |
          qumod whoami --json

      - name: Ensure the project exists
        env:
          QUMO_TOKEN: ${{ secrets.QUMO_API_TOKEN }}
        run: |
          # List first, on its own: a failed list must fail the step, not
          # fall through to creating a duplicate project. A prod project needs
          # the Pay as you go or Enterprise plan; on Free, create answers 402.
          projects="$(qumod project list --json)"
          echo "$projects" | jq -e '.[] | select(.name == "my-stream-app")' >/dev/null \
            || qumod project create my-stream-app --env prod --json

GitLab CI Integration

.gitlab-ci.yml

stages:
  - qumo

qumo_project:
  stage: qumo
  # The Linux binaries are built for glibc; Alpine's musl cannot run them.
  image: debian:stable-slim
  before_script:
    - apt-get update && apt-get install -y --no-install-recommends ca-certificates curl jq
    - curl -fsSL https://dl.qumo-deploy.com/qumod/install.sh | QUMOD_INSTALL=/usr/local sh
  script:
    - qumod whoami --json
    - projects="$(qumod project list --json)"
    - echo "$projects" | jq -e '.[] | select(.name == "my-stream-app")' >/dev/null || qumod project create my-stream-app --env prod --json
  only:
    - main
  variables:
    QUMOD_VERSION: "0.261108.0"
    QUMO_TOKEN: "$QUMO_API_TOKEN"

Coding Agent Recipes (Claude Code, Antigravity, Copilot)

When delegating commands to automated coding agents:

Always enable --json: Ensures deterministic parsability of responses.
Handle API URL overrides: When developing against local testbeds, pass --api-url http://localhost:8080 or set QUMO_API_URL.
Parse stdout and stderr separately: with --json, stdout carries only JSON, one document per line, and errors go to stderr. qumod login --json writes two lines, pending and then authorized.
Read a command’s usage with qumod <command> --help.

Agent Invocations

# Query the active organization and role
qumod whoami --json

# List the organization's projects
qumod project list --json

# Find the dev project, for a relay you run yourself (every organization
# starts with one; creating a second answers 409)
qumod project list --json | jq '.[] | select(.environment == "dev")'

​CI/CD & Coding Agents

​Exit Codes

​GitHub Actions Integration

​GitLab CI Integration

​Coding Agent Recipes (Claude Code, Antigravity, Copilot)

​Agent Invocations