Skip to content

signalgridco/signalgrid-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 

Repository files navigation

Signalgrid Push CLI

A lightweight Bash CLI for interacting with the Signalgrid API.
It allows you send notifications and test the connection to the API Servers.

Installation

curl -fsSL https://signalgrid.co/install.sh | bash

Configuration

Once you provide your client-key to the install script, everything is set up.

Usage

signalgrid [command] [options]

Commands

ping

Check connectivity to the configured endpoint.

signalgrid ping

The command returns:

  • OK if reachable
  • FAIL otherwise

help

Display the help page.

signalgrid help

send

Send a notification to a channel.

signalgrid send [options]

Required options

-c, --channel   [Hash]    Channel token
-b, --body      [String]  Notification body

Optional options

-s, --severity  [String]  crit | warn | info | success (default: info)
-C, --critical            Mark as critical
-t, --title     [String]  Notification title
-e, --endpoint  [FQDN]    Override endpoint

Examples

Ping default server:

signalgrid ping

Send a notification:

signalgrid send \
  -c 098f6bcd4621d373cade4e832627b4f6 \
  -s crit \
  -t "Backup Failed" \
  -b "Disk is full" \

Send a critical notification:

signalgrid send \
  -c 098f6bcd4621d373cade4e832627b4f6 \
  -s crit \
  -t "Backup Failed" \
  -b "Disk is full" \
  -C

About

Official cli command for Signalgrid

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages