seyren-cli v0.4.1

seyren-cli

A CLI for seyren.

Installing

Firstly, ensure that nodejs is installed. You'll typically find this available in your OS package manager.

Once installed, you can install seyren-cli itself:

npm install -g seyren-cli

(You may need to run this under sudo.)

Configuration

You will need a very simple configuration file setup in ~/.seyren/config.json. The contents are:

{
    seyrenUrl: "http://your_seyren_host"
}

Now you're good to go.

Running

To see a list of available commands just run:

seyren

Examples

• Display a list of all checks:

seyren search

• Display a list of all checks containing "mytext" in their name

seyren search mytext

• Display the details of the check with id "mycheckid"

seyren check mycheckid

• Display the raw JSON of the check with id "mycheckid"

seyren check mycheckid --raw

• Display the details of the 5th check from the last search

seyren check 5

• Open the 3rd check from the last search in a browser

seyren open 3

• Status dashboard for all favourite checks (includes period spent in warn or error state in last 24 hours)

seyren dashboard

Contributing

Rather than installing from npm you're better off running from the source code itself. Firstly, make sure you've uninstalled seyren-cli (npm uninstall seyren-cli) then clone the repo and then:

npm link

This will create a symlink from the source seyren executable to the global node_modules folder. So, you should now be able to run seyren as if you installed via npm.

The build tool is gulp. So, make sure that ./node_modules/.bin is on your path and then run gulp. (You could install gulp globally of course but then you're not guaranteed to be using the version of gulp that's used in the travis CI build.)