statuspage-cli

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2018 License: GPL-3.0 Imports: 3 Imported by: 0

README

statuspage-cli

Statuspage.io CLI tool

Synopsis

This commandline tool interacts with the statuspage.io API.

note: Beware, this is work in progress and without warranty! It might be broken.

Features:

  • Create user
  • Delete user
  • Search user
  • Everything else

Installation:

Get the binary from the release page or build it yourself using go get.

Configuration:

Get the pageid and apikey in your statuspage.io admin panel and create a .statuspage.yaml file in your home directory with the following content:

 sp_pageid: <pageid>
 sp_apikey: <apikey>

statuspage options

      --config string   config file (default is $HOME/.statuspage.yaml)
      --debug           debug mode
  -h, --help            help for statuspage
      --version         version for statuspage
Create a user

Create a subscriber through email adres. The subsciber needs to confirm the email from statuspage to receive notifications. The subscriber is then added to all the components by default.

statuspage subscriber create [email address]
Examples
statuspage subscriber create [email@example.org]
Options
  -h, --help   help for create
Options inherited from parent commands
      --config string   config file (default is $HOME/.statuspage.yaml)
      --debug           debug mode
Delete a user

Delete a subscriber through email adres

statuspage subscriber delete [email address]
Examples
statuspage subscriber delete [email@example.org]
Options
  -h, --help   help for delete
Options inherited from parent commands
      --config string   config file (default is $HOME/.statuspage.yaml)
      --debug           debug mode
Search subscriber

Search a subscriber

Synopsis

Search a subscriber through email adres

statuspage subscriber search [email address]
Examples
statuspage subscriber search [email@example.org]
Options
  -h, --help   help for search
Options inherited from parent commands
      --config string   config file (default is $HOME/.statuspage.yaml)
      --debug           debug mode

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL