Skip to content

CLI

import { Aside } from ‘@astrojs/starlight/components’;

Install

With Homebrew (macOS or Linux):

Terminal window
brew install crontinel/tap/crontinel

Or download the archive for your platform from the v0.1.1 release (darwin or linux, amd64 or arm64), unpack it and put crontinel on your PATH:

Terminal window
curl -fsSL https://github.com/crontinel/cli/releases/download/v0.1.1/crontinel_0.1.1_linux_amd64.tar.gz | tar xz
sudo mv crontinel_0.1.1_linux_amd64/crontinel /usr/local/bin/

Authenticate

The CLI uses your app’s key, the same one the check-in uses. Pass it as --key or set it in the environment:

Terminal window
export CRONTINEL_API_KEY=your-app-key

Commands

Terminal window
crontinel ping # check the key and connection
crontinel monitors # jobs that reported to this app, with their last status
crontinel alerts # recent alerts for this app
crontinel events # alerts from the last 72 hours

ping prints:

✓ Connected to Crontinel
Available tools: 7

monitors prints one line per job:

Scheduled jobs (2):
✗ nightly-import (last: failed)
● orders-sync (last: completed)

health is an alias for ping, and list for monitors.

Options

OptionMeaning
--key <key>App key. Defaults to CRONTINEL_API_KEY.
--url <url>API URL. Defaults to https://app.crontinel.com.
--jsonPrint the raw JSON response.