@witness/cli

CLI tool for uploading sourcemaps and build artifacts to Witness.

Installation

npm install -g @witness/cli

Usage

Basic Usage

witness-upload \
  --endpoint https://api.witness.dev \
  --project my-app \
  --api-key abc123 \
  --file dist/main.js.map \
  --type sourcemap \
  --app-version 1.0.0

Using Environment Variables

export WITNESS_ENDPOINT=https://api.witness.dev
export WITNESS_PROJECT_SLUG=my-app
export WITNESS_API_KEY=abc123

witness-upload --file dist/main.js.map --app-version 1.0.0

Upload ProGuard Mapping (Android)

witness-upload \
  --file app/build/outputs/mapping/release/mapping.txt \
  --type proguard \
  --app-version 1.0.0 \
  --build-number 42 \
  --bundle-id com.example.app

Upload dSYM (iOS)

witness-upload \
  --file MyApp.app.dSYM.zip \
  --type dsym \
  --app-version 1.0.0 \
  --build-number 42 \
  --bundle-id com.example.app

Options

| Option | Environment Variable | Description | Required | |--------|---------------------|-------------|----------| | --endpoint | WITNESS_ENDPOINT | Witness API endpoint | Yes | | --project | WITNESS_PROJECT_SLUG | Project slug | Yes | | --api-key | WITNESS_API_KEY | API key | Yes | | --file | - | Path to artifact file | Yes | | --app-version | - | App version | Yes | | --name | - | Artifact name (defaults to filename) | No | | --type | - | Artifact type: sourcemap, bundle, proguard, dsym, auto | No (default: auto) | | --build-number | - | Build number | No | | --bundle-id | - | Bundle ID | No |

CI/CD Integration

GitHub Actions

- name: Upload sourcemaps
  run: |
    npx @witness/cli \
      --file dist/main.js.map \
      --app-version ${{ github.ref_name }} \
      --build-number ${{ github.run_number }}
  env:
    WITNESS_ENDPOINT: ${{ secrets.WITNESS_ENDPOINT }}
    WITNESS_PROJECT_SLUG: my-app
    WITNESS_API_KEY: ${{ secrets.WITNESS_API_KEY }}

GitLab CI

upload-sourcemaps:
  script:
    - npx @witness/cli --file dist/main.js.map --app-version $CI_COMMIT_TAG
  variables:
    WITNESS_ENDPOINT: $WITNESS_ENDPOINT
    WITNESS_PROJECT_SLUG: my-app
    WITNESS_API_KEY: $WITNESS_API_KEY

License

MIT