Git Product home page Git Product logo

pigil's Introduction

Pigil Banner

release GitHub License PRs Welcome

Pigil

A process vigilance system written in GoLang

๐Ÿค” What is Pigil?

Pigil (Process vIGILance) is a self-hosted process watcher, that notifies you as soon as your process fails via an e-mail. It also maintains a record of all your commands for easier tracking.

Pigil keeps an eye on your processes when you have huge, time-taking builds and sends a notification via E-mail if the process fails to avoid any lapses in efficiency.

๐Ÿ’ป Usage

Pigil currently has the following commands:

  1. Install Pigil
  2. Setup atleast one of the following notification channels:
    1. Gmail Notifications
    2. Discord Notifications
  3. Run any command just prefix pigil
     pigil <your command> # eg: pigil echo "This command is watched by pigil"
  4. Any failure in the command will trigger an email notification on all your devices

Pigil Commands

  1. pigil <command>: will run the command and notify on failure
  2. pigil bumf auth: will produce an authentication url
  3. pigil bumf channels: setup channels of notification like discord/email
  4. pigil bumf discord: Enable/Disable discord webhook
  5. pigil bumf db: shows you the history of commands with thier execution time
  6. pigil bumf status: shows current configurations
  7. pigil bumf logout : Will log you out of your gmail account

โฌ‡ Installation

Using Homebrew

brew tap DarthBenro008/pigil
brew install pigil

Using NPM

npm install -g pigil

Using Yarn

yarn global add pigil

Building from source

  1. Create a GCP Project
  2. Get GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET by creating an Oauth Client from GCP Console
  3. Clone the project using the command git clone https://github.com/DarthBenro008/pigil
  4. Create a file named secrets.txt in the root of the project
  5. Paste your GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET seperated by space
  6. Run the command go build
  7. If you are on Linux/MacOS, make sure you move the binary to somewhere in your $PATH (e.g. /usr/local/bin).

Manual Installation

You can also download the binary and install it manually.

  • Go to releases page and grab the latest release of gunfollower.
  • Download the latest release of gunfollower specific to your OS.
  • If you are on Linux/MacOS, make sure you move the binary to somewhere in your $PATH (e.g. /usr/local/bin).

Sample Channel Notifications

Sample Email Notification

sample

Sample Discord Notifiation

discord_sample

๐Ÿค Contributions

  • Feel Free to Open a PR/Issue for any feature or bug(s).
  • Make sure you follow the community guidelines.
  • Feel free to open an issue to ask a question/discuss anything about pigil.
  • Have a feature request? Open an Issue!

๐Ÿ“ข Shoutouts

Shoutout to Khyati Gupta for amazing logo and banner illustrations

โš– License

Copyright 2022 Hemanth Krishna

Licensed under MIT License : https://opensource.org/licenses/MIT

Made with โค , two cups of coffee and some chaii

pigil's People

Contributors

darthbenro008 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.