https://github.com/shekohex/impulse

🎇 send a push notification when your long build command finish
https://github.com/shekohex/impulse

impulse notification

Last synced: 3 months ago
JSON representation

🎇 send a push notification when your long build command finish

• Host: GitHub
• URL: https://github.com/shekohex/impulse
• Owner: shekohex
• License: mit
• Created: 2020-08-03T12:10:45.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-21T20:16:06.000Z (over 1 year ago)
• Last Synced: 2024-04-13T22:58:39.962Z (3 months ago)
• Topics: impulse, notification
• Language: Rust
• Homepage: http://impulse-build.netlify.app
• Size: 44.9 KB
• Stars: 62
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Lists

• awesome-list - impulse

README

        
Impulse 🔔



  

    A CLI Tool to Send a Push Notifications when a command completes.

  








  

    

  

   

    

  

  

    

  



## About

Example:

```bash

$ impulse 'cargo build'

```

## Install

1. [Github Releases](https://github.com/shekohex/impulse/releases)

2. Or if you want to build it localy

```bash

$ git clone https://github.com/shekohex/impulse.git

$ cd impulse

$ cargo install

```

## Usage

1. Goto [Impulse Website](https://impulse-build.netlify.app/) and enable push notifications (the small red bell in the bottom right corner).

2. Copy your UserID and set `IMPULSE_USER_IDS` env to the UserID value.

```bash

Usage: impulse  [--uids ] [-s ] [-e ]

Send push notification when your long build command finish

Options:

  --uids            override the UserIDs that we will send notification to.

                    normally this will be stored in `IMPULSE_USER_IDS` env. UIDs

                    is separated by `,`.

  -s, --success-message

                    set the success message. default to: Build exit successfully

  -e, --error-message

                    set the error message. default to: Build errored

  --help            display usage information

```

## FAQ

1. How do I support more than device (like my other laptop or mobile)?

- the `IMPULSE_USER_IDS` env accept more than one UID. just seprate them by a `,`.

2. How do I ..?

- Open an issue :)

## Contributing

Want to join us? Check out our ["Contributing" guide][contributing] and take a

look at some of these issues:

- [Issues labeled "good first issue"][good-first-issue]

- [Issues labeled "help wanted"][help-wanted]

[contributing]: https://github.com/shekohex/impulse/blob/master/.github/CONTRIBUTING.md

[good-first-issue]: https://github.com/shekohex/impulse/labels/good%20first%20issue

[help-wanted]: https://github.com/shekohex/impulse/labels/help%20wanted

## Safety

This crate uses `#![deny(unsafe_code)]` to ensure everything is implemented in

100% Safe Rust.

## License



Licensed under MIT license.








Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in this crate by you, as defined in the MIT license, without any additional terms or conditions.