Install the CLI

The orvane CLI is a single static binary for Linux, macOS and Windows. Beta workspaces get a download link in their invitation email. In CI you can use the container image instead:

docker run --rm -e ORVANE_TOKEN registry.ionolab.net/orvane/cli:1 deploy mark --service web

Connect a workspace

Create a token under Settings → API tokens and make it available as ORVANE_TOKEN. Tokens are scoped to one workspace; use a separate token per pipeline so you can revoke them one at a time.

export ORVANE_TOKEN=ovt_live_…
orvane whoami

Mark deploys

Call orvane deploy mark at the end of a successful deploy. Orvane records the time, the version and the commit, and works out the commit range from the previous deploy of the same service.

orvane deploy mark --service api --version v5.7.2 --commit "$GIT_SHA" --env production

For GitHub Actions, add a step after your deploy step:

- name: Tell Orvane
  run: orvane deploy mark --service web --version "${{ github.ref_name }}" --commit "${{ github.sha }}"
  env:
    ORVANE_TOKEN: ${{ secrets.ORVANE_TOKEN }}

Uptime checks

Uptime checks run from three regions (EU West, EU Central, US East). A check fails only when two regions agree, which removes most false alarms caused by a single network path.

Browser checks

A browser check is a short script of steps (open, click, fill, expect) that runs in a real browser. Every run is recorded. While a check runs you can open it in the dashboard and watch it live; afterwards the recording is kept for 14 days so you can see exactly where a failing flow stopped.

orvane check browser add "Checkout" \
  --open https://shop.example.com \
  --click "text=Add to cart" --click "text=Checkout" \
  --expect-text "Order summary" \
  --every 10m --regions eu-west,us-east

Alerts

Alerts go to email, Slack, Matrix or any webhook. Orvane sends one alert when an incident starts and one when it ends, and links both to the deploys around that time.

API

The REST API lives at https://orvane.ionolab.net/api/v1 and accepts the same tokens as the CLI, as a bearer token. Responses are JSON.

curl -H "Authorization: Bearer $ORVANE_TOKEN" \
  https://orvane.ionolab.net/api/v1/deploys?service=web&limit=20

Limits

The API allows 600 requests per minute per workspace. During the beta, workspaces are limited to the Team plan's allowances; write to us if you need more.