README.md

checkson-cli

A command-line interface for Checkson

Installation

Ubuntu / Debian

Download the newest .deb package for your architecture from the releases page.

Then:

sudo apt install ./checkson-cli_1.0.16_linux_amd64.deb

Snap

sudo snap install checkson

Manual

Download the newest .tar.gz file for your architecture from the releases page.

Then:

tar xvzf checkson-cli_1.0.16_linux_amd64.tar.gz -C /tmp
sudo mv /tmp/checkson /usr/local/bin

Usage

Login to Checkson

checkson login

You will be asked to login on https://app.checkson.io and to authorize the CLI.

List checks

This shows the status of all checks:

checkson list

Create check

This creates a new check that checks a website for SSL/TLS errors and sends an email if a problem is found:

checkson create new-check \
  --docker-image ghcr.io/checkson-io/checkson-testssl-check:main \
  --env URL=https://yourwebsite.com \
  --email me@example.com

Show check details

This shows details of the given check:

checkson show new-check

Origin

This command line tool is partly based on kafkactl

Development

• Install golangcli-lint

Releasing

In order to release a new version, do the following:

git tag -a v1.0.16 -m "v1.0.16"
git push origin v1.0.16