rewire-cli

CLI for Rewire — wrap any command with OpenTelemetry collection. It starts an otelcol-contrib sidecar, creates a run via the Rewire API, injects OTEL environment variables into your subprocess, and streams traces and host metrics to your Rewire dashboard.

Installation

npm install -g rewire-cli

Or run directly with npx rewire-cli.

Usage

rewire run [options] -- <command...>

Options

| Flag | Default | Description | |---|---|---| | --repo <name> | required | Repo name to group this run under | | --job <name> | default | Job name label | | --workflow <name> | local | Workflow name label | | --endpoint <url> | http://localhost:3000 | Rewire server URL | | --api-key <key> | — | API key (or set REWIRE_API_KEY) | | --no-collector | false | Skip the OTel collector sidecar | | --version <ver> | 0.114.0 | otelcol-contrib version to use | | --help | — | Show help |

Examples

# Run your test suite with telemetry
rewire run --repo my-project -- npm test

# Use a different job name
rewire run --repo my-project --job lint -- npm run lint

# Skip the collector (traces only, no host metrics)
rewire run --repo my-project --no-collector -- npm test

Configuration

Config is resolved in this precedence order (highest first):

1. CLI flags
2. Environment variables
3. .rewire.json in the current working directory
4. ~/.rewire.json in your home directory

Environment variables

| Variable | Description | |---|---| | REWIRE_API_KEY | API key | | REWIRE_ENDPOINT | Rewire server URL | | REWIRE_REPO | Repo name |

Config file (.rewire.json)

{
  "apiKey": "rw_...",
  "endpoint": "https://rewireci.com",
  "repo": "my-project"
}

How it works

1. Creates a run via the Rewire API (POST /api/public/v1/runs)
2. Downloads and caches otelcol-contrib to ~/.rewire/bin/ (skipped if already cached)
3. Writes an OTEL collector config and starts the sidecar
4. Injects OTEL_* env vars into the subprocess so it exports traces to the local collector
5. Runs your command, forwarding stdin/stdout/stderr
6. Stops the collector on exit and prints the run URL

Development

npm install
npm run build       # type-check + bundle with ncc
npm test            # run unit tests
npm run typecheck   # type-check only

Supported platforms

• Linux (x64, arm64)
• macOS (x64, arm64)