Have you ever wanted a simple tool in your terminal which gives you notification when the program is done, like some computer notification or some mail.
This tool helps you ease your life with appropriate notifications you can set in your OS, get mail regarding it and best of all, it is VERY SIMPLE TO USE!
ntfyme stands for 'notify-me', obviously! So just write your command and pipe the notification of its Error(or Success) with ntfyme.
TBD
- Very easy to use and setup.
- Cross platform support for Windows, MacOS and Linux.
- Get local notifications when your command is done.
- Get notifications like gmail, telegram bot, etc. when your command is done.
- Get information about output, errors, time taken, pid and more in the notification.
Say you want to run your terminal command called <command>, which can be running some python script, some shell scripts, or any terminal regular command.
There are mainly two ways to use the tool to get a notification -
For "direct running", you can follow the below format -
ntfyme -c <command>For "piping the command", you can follow the below format -
echo <command> | ntfymeBoth the above commands will give the SAME output, a notification when the command is done.
You can install this tool with the below options available:
You can download this tool by running the below command -
pip install ntfymeThis tool can downloaded from my Homebrew tap, by running the below command -
brew install anirudhg07/anirudhg07/ntfymeYou can download the source code from the repository and run the below command to install the tool -
git clone https://github.com/AnirudhG07/ntfyme.git
cd ntfyme
pip install .To get started with ntfyme, first download the tool using the above installation methods. To enable notifications through gmail or telegram bot, you will need to setup the respective services manually. The guides to setup the services are mentioned in the docs.
To know more about the config.toml and configurations, read below.
ntfyme allows you to configure the tool according to your needs. The configurations are stored in the config.toml which you can open using root privilages while running ntfyme --config. Let's understand some of the configurations below.
ntfyme uses on/off to enable/disable ny settings. Please do not input any other values other than on/off for the enabled option.
In this key, we allow you to print the output of the command run inside the terminal itself. This is useful when you want to see the output of the command run in the terminal itself. By default, this is set to on.
To view the log page, you can run ntfyme --log which will use the log_pager value present in the toml file. By default, it is set to cat. You can set it to less, bat, more, etc. according to your needs and OS.
Here you can set your mail_id, encrypted app password which you can get by entering your password in ntfyme --enc.
Here you can set your bot_token and chat_id which you can get by creating a bot in telegram.
For local notification, the code will automatically detect your OS and based on that, will select [local_{os}] key. Currently only Sppecial configurations for MacOS is present. You will have to change ena
5095
bled to on/off to enable/disable local notification.
PLEASE DO NOT change other OS's configurations for no reason.