# pigil

> Process vIGILance system that notifies you when your process fails via an e-mail, and is also capable of maintaining a record of all your commands for easier tracking.

Latest version **0.2.0** (published 2022-06-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install pigil
pnpm add pigil
yarn add pigil
bun add pigil
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2022-06-21 |
| First published | 2022-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 278.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 7 |
| Author | DarthBenro008 |
| Maintainers | darthbenro008 |
| Keywords | process-watcher |

## Links

- npm: https://www.npmjs.com/package/pigil
- Repository: https://github.com/DarthBenro008/pigil
- Homepage: https://github.com/DarthBenro008/pigil#readme
- Issues: https://github.com/DarthBenro008/pigil/issues
- npm.io page: https://npm.io/package/pigil

## Dependencies (1)

- [@gzuidhof/go-npm](https://npm.io/package/@gzuidhof/go-npm.md) ^0.1.13

## Recent versions

- 0.2.0 (latest) — 2022-06-21
- 0.1.5 — 2022-06-18
- 0.1.4 — 2022-06-18

## README

![Pigil Banner](assets/banner.png)

![release](https://img.shields.io/github/v/release/DarthBenro008/pigil)
[![GitHub License](https://img.shields.io/github/license/aryan9600/cowin-notifier)](https://github.com/DarthBenro008/pigil/blob/master/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/DarthBenro008/pigil/issues/new/choose)

# 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](https://github.com/DarthBenro008/pigil/wiki/Setting-up-Gmail-Channel)
   2. [Discord Notifications](https://github.com/DarthBenro008/pigil/wiki/Setting-up-Discord-notification-channel)
3. Run any command just prefix pigil
   ```bash
    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

```bash
brew tap DarthBenro008/pigil
brew install pigil
```

### Using NPM

```bash
npm install -g pigil
```

### Using Yarn

```bash
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](https://github.com/DarthBenro008/pigil/releases) 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](assets/sample.png)

### Sample Discord Notifiation

![discord_sample](assets/discord.png)

## 🤝 Contributions

- Feel Free to Open a PR/Issue for any feature or bug(s).
- Make sure you follow the [community guidelines](https://docs.github.com/en/github/site-policy/github-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](https://www.behance.net/khyatigupta267) for amazing logo and banner illustrations

## ⚖ License

Copyright 2022 Hemanth Krishna

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

<p align="center">Made with ❤ , two cups of coffee and some chaii</p>

---
_Source: https://npm.io/package/pigil · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._