notigator

command module
v1.0.5 Latest Latest
Warning

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

Go to latest
Published: May 11, 2021 License: MIT Imports: 3 Imported by: 0

README

Notigator

This library provides a way to aggregate notifications in one sigle view

notigator

How to install

It uses GO +1.11

$> go get github.com/xescugc/notigator
$> cd $GOPATH/src/github.com/xescugc/notigator
$> go install .

How to use

Basically run

$> notigator serve

It'll start a server at localhost:3000 by default, to get more information use

$> notigator -h

Docker

If you want to use it from docker this is the "default" example:

$> docker run --rm -d -p 3000:3000 -v "${HOME}/.notigator.json":/app/.notigator.json xescugc/notigator serve --config /app/.notigator.json

Configure

You can configure notigator with config file. The config file should look like this (by default on $HOME/.notigator):

{
  "sources": [
    {
      "name": "Display name",
      "token": "Token",
      "canonical": "github"
    }
  ]
}

Note: All the flags can also be passed via config file or envs.

To have more documentation on the supported Sources and how to configure them read the wiki

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Code generated for package assets by go-bindata DO NOT EDIT.
Code generated for package assets by go-bindata DO NOT EDIT.

Jump to

Keyboard shortcuts

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