https://github.com/jkrup/pwatch

Get Notifications When Processes / Jobs Complete
https://github.com/jkrup/pwatch

cli-utilities nodejs notifier

Last synced: about 1 year ago
JSON representation

Get Notifications When Processes / Jobs Complete

• Host: GitHub
• URL: https://github.com/jkrup/pwatch
• Owner: jkrup
• Created: 2017-02-20T17:29:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-06T23:35:57.000Z (over 9 years ago)
• Last Synced: 2024-10-19T15:17:40.675Z (over 1 year ago)
• Topics: cli-utilities, nodejs, notifier
• Language: JavaScript
• Homepage:
• Size: 259 KB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# PWatch [![npm version](https://badge.fury.io/js/pwatch.svg)](https://badge.fury.io/js/pwatch)

Get native notifications when your long running processes finish!

Running Database Migrations? Deploying apps? Compiling? Transfering large files? Get notified when your process has finished.

![](https://github.com/mazlix/pwatch/raw/master/assets/pwatchinaction.png)

## Install

Install it with [yarn](https://github.com/yarnpkg/yarn/) or npm:

```

$ npm install -g pwatch

```

## Usage

Add `pwatch` at the end of your command.

```

  pwatch 

  Commands:

    search      [name]      Lists all processes by PID that match "name"

  Examples:

    – Notifies after 10 seconds

      ${'$ sleep 10 | pwatch'.cyan}

    – See all PID for node related processes

      ${'$ pwatch search node'.cyan}

    – Notify me when process 4030 ends

      ${'$ pwatch 4030'.cyan}

    – Run a chained process in background with a &

      ${'$ sleep 10 | pwatch &'.cyan}

```

### Examples

```

sleep 10 | pwatch

```

or

```

sleep 10 && pwatch

```

or 

```

sleep 10; pwatch

```

Optionally add a `&` so pwatch runs in the background

```

sleep 10 | pwatch &

```

Or if you forget to call it when running your command

```

$ scp somelargefile.tar.gz root@remotehost:~

$ pwatch search scp

    60132 - 0:00.20 scp somelargefile.tar.gz root@remotehost:~

$ pwatch 60132

```

You can even use it to be notified upon SSH tunnel closing.

```

$ ssh root@remotehost

# in another shell...

$ ps aux | grep ssh

justink          60132   0.0  0.2  3041904  31712 s018  S+   12:15PM   0:00.20 ssh root@remotehost

$ pwatch 60132

```

![](https://github.com/mazlix/pwatch/raw/master/assets/pwatch.gif)

Then get notified when that process finishes.