Skip to content

Start

Quickstart

Install the CLI, add an endpoint, read the first observation, and follow an incident through to its evidence record.

Install the CLI

Everything below is one path, and the fastest way through it is the CLI. The npm and pipx packages are thin installers that download the verified binary on first run; Go builds from source.

bash
npm install -g reliastra
# or
pipx install reliastra
# from source
go install github.com/ReliaAstra/Reliastra/cli/cmd/reliastra@latest
reliastra --version

The CLI lives in that repository at cli/, a Go module with no dependencies beyond the standard library. The npm/pip installers share one cache and verify SHA-256 against the release checksums.txt. From a checkout, go build -o reliastra ./cli/cmd/reliastra produces the binary and go run ./cli/cmd/reliastra … runs without installing. See cli/README.md for verification details.

What you need

  • An HTTPS endpoint you are authorized to monitor. Any URL that returns a status code works; it does not have to be health-check-shaped.
  • An account. The trial starts on signup, no card.

Add a dependency

From the console: Dependencies → Add, paste the URL, choose an interval. Or from the CLI:

bash
reliastra login --email you@example.com
reliastra deps add "Payments API" https://api.example.com/health --interval 60

Or directly against the API:

POST /v1/dependenciesbash
curl -sS https://api.reliastra.com/v1/dependencies \
 -H "Authorization: Bearer $RELIASTRA_TOKEN" \
 -H 'Content-Type: application/json' \
 -d '{
    "name": "Payments API",
    "endpoint_url": "https://api.example.com/health",
    "check_interval_seconds": 60,
    "expected_status_codes": [200]
  }'
201 Createdjson
{
  "id": "9f1c8b0e-6a2f-4f1e-9f3a-1c2d3e4f5a6b",
  "name": "Payments API",
  "endpoint_url": "https://api.example.com/health",
  "method": "GET",
  "expected_status_codes": [200],
  "timeout_seconds": 10,
  "check_interval_seconds": 60,
  "regions": ["us-east"],
  "is_active": true,
  "next_check_at": "2026-09-18T10:01:00Z"
}

The first observation

The scheduler picks the dependency up on the next tick and writes one row per probe. There is nothing to enable and no agent to install - the probe is issued by RELIASTRA, not by you.

GET /v1/checks/recentbash
reliastra checks recent --limit 5

EXECUTED (UTC)         RESULT   STATUS  LATENCY   DETAIL  DEP
2026-09-18 10:01:03Z   up           200  184 ms            dep-9f1c

Follow an incident

When the detector opens an incident, the incident - not the individual probe - is the thing to read. Its window, severity and root-cause field are one record:

bash
reliastra incidents list --status open
reliastra incidents show <incident-id>
reliastra incidents show <incident-id> --evidence

--evidence follows the record to the evidence artifact issued for it, so the window, the detector’s rule, the observation list and the integrity hashes are one command away rather than three.

Retrieve evidence and verify it

bash
reliastra evidence list
reliastra evidence show <report-id>              # prints the public verification URL
reliastra evidence get <report-id> --out incident.pdf
reliastra verify <verification-id> --file incident.pdf

verify needs no account: it reads the public verification record, recomputes the SHA-256 of the bytes on disk and compares it with the checksum recorded at issue time. It exits 4 when they disagree, which is what makes it usable directly as a gate:

GitHub Actionsyaml
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
  with: { go-version: '1.23' }
- run: go run ./cli/cmd/reliastra verify "$VERIFICATION_ID" --file incident.pdf

Between the terminal and the web

The CLI and the console are two views of one record, and the CLI prints the address of the other view rather than describing what it would show.

bash
reliastra open incident <incident-id> --browser
reliastra open verify <verification-id>          # prints the URL; no account needed
open "$(reliastra open evidence <report-id>)"    # printing is the default, so this composes
  • Every identifier is the same in both places: an incident id from incidents list opens the same incident in the console.
  • --json prints the API’s own shape, so a script sees exactly what the API returned.
  • --web adds the console URL to the list commands; evidence show prints the verification URL unconditionally.
  • A self-hosted deployment points the links at its own origin with --site-url or RELIASTRA_SITE_URL.

Where to go next

CLI
Every command, the exit codes, and how to use it in a pipeline.
REST API
The endpoints behind the CLI, scopes for API keys, pagination and error semantics.
Configuration
Intervals, expected status codes, secret headers, disabling without deleting.
Incidents
How the detector decides, what severity means, and how an incident closes.
Evidence
Turning a resolved incident into a record you can hand to someone.
Verification
What the public record proves, and what it deliberately does not.

Problem with this page?

These guides live in the repository. An inaccuracy in the documentation is a bug, and the fastest fix is an issue with the sentence quoted. Open an issue.

Next

Concepts →

Four ideas the rest of these docs assume: observation, confirmation, attribution, evidence.

Read the methodology, or run the thing.

Every rule in these guides has a page stating its thresholds and its limits. The other way to check it is to add a dependency and watch what the detector does.