Use the Revyl CLI in a Mac CI job

The Revyl CLI is already installed at /opt/revyl/bin/revyl. Use it for local identity checks without a secret, or pass your own REVYL_API_KEY when the job needs to read the computer report or call another Revyl API.

Set up with an agent

Paste one prompt and your coding agent does the rest.

Setup prompt

Add a Revyl CLI check and computer report to this Mac CI job.

Read https://docs.revyl.com/cookbooks/revyl-cli-in-macos-job.md and follow it. It's the current Revyl guide for this, so prefer it over anything you remember about Revyl.

Add `REVYL_API_KEY` as a repository or organization secret, then copy this workflow. Keep the key in the step environment and never echo it or pass it as a command-line argument.

You're done when the CLI version step passes and the computer report is saved as a private job artifact.

Ask me before anything that needs my login or approval.

Workflow

name: Revyl CLI on Mac

on:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  cli:
    if: >-
      github.event_name == 'workflow_dispatch' ||
      (github.event_name == 'pull_request' &&
       github.event.pull_request.head.repo.full_name == github.repository)
    runs-on: revyl-macos
    timeout-minutes: 15
    steps:
      - name: Check the preinstalled CLI
        run: /opt/revyl/bin/revyl version

      - name: Read the computer report
        env:
          REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
        shell: bash
        run: |
          set -euo pipefail
          test -n "$REVYL_API_KEY"
          test -n "$REVYL_COMPUTER_ID"
          umask 077
          /opt/revyl/bin/revyl computer report "$REVYL_COMPUTER_ID" --format json \
            > "$RUNNER_TEMP/computer-report.json"

      - name: Upload the report JSON
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: revyl-computer-report
          path: ${{ runner.temp }}/computer-report.json
          if-no-files-found: ignore

The report file can contain run metadata. Keep the artifact private to the repository and do not put the API key or a session URL into logs. The CLI's human progress and warnings go to the job log; --format json is the machine-readable report output.

What you see in Revyl

The command appears in the computer's Activity timeline. The computer page keeps the desktop recording after the computer stops, and the Sessions list associates the run with GitHub Actions plus the pull request or branch when that metadata is available.

The report call uses the same preinstalled CLI path as the first-job cookbook. Keep the report artifact private because it contains run metadata.

Common failures

AUTH_MISSING: add REVYL_API_KEY as a repository or organization secret. The runner's REVYL_COMPUTER_ID is not an API credential.
Fork pull request: GitHub does not pass repository secrets to an untrusted fork, so skip this job or use a trusted same-repository trigger.
The report is empty at job exit: the final desktop recording may still be finalizing; open the computer page after the computer stops.
The CLI path differs: use /opt/revyl/bin/revyl on revyl-macos, then report the image issue rather than installing a second CLI.

WorkflowCopy Anchor Link

What you see in RevylCopy Anchor Link

Common failuresCopy Anchor Link

On this page

Workflow

What you see in Revyl

Common failures