{"id":19637987,"url":"https://github.com/anirudhg07/ntfyme","last_synced_at":"2025-04-28T10:30:29.931Z","repository":{"id":249473105,"uuid":"831618288","full_name":"AnirudhG07/ntfyme","owner":"AnirudhG07","description":"Simple terminal command line notification tool on completion of your commands and processes.","archived":false,"fork":false,"pushed_at":"2024-10-08T15:35:41.000Z","size":72564,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T08:05:31.445Z","etag":null,"topics":["cli","notification","notify"],"latest_commit_sha":null,"homepage":"https://ntfyme.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnirudhG07.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-21T05:37:47.000Z","updated_at":"2025-04-02T08:49:21.000Z","dependencies_parsed_at":"2024-08-05T16:40:56.217Z","dependency_job_id":null,"html_url":"https://github.com/AnirudhG07/ntfyme","commit_stats":null,"previous_names":["anirudhg07/notify-cli","anirudhg07/ntfyme"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhG07%2Fntfyme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhG07%2Fntfyme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhG07%2Fntfyme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnirudhG07%2Fntfyme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnirudhG07","download_url":"https://codeload.github.com/AnirudhG07/ntfyme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251295067,"owners_count":21566390,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","notification","notify"],"created_at":"2024-11-11T12:37:19.439Z","updated_at":"2025-04-28T10:30:27.563Z","avatar_url":"https://github.com/AnirudhG07.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ntfyme 📣 ![Static Badge](https://img.shields.io/badge/version-0.0.2-blue)\n\n\u003cp align=\"center\"\u003e\n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/MacOS-red\"\u003e\u003c/a\u003e\n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/Linux-blue\"\u003e\u003c/a\u003e\n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/Windows-green\"\u003e\u003c/a\u003e\n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/WSL-yellow\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/Gmail-cyan\"\u003e\u003c/a\u003e \n    \u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/Telegram-pink\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"#-previews\"\u003e📷 Previews/Screenshots\u003c/a\u003e •\n    \u003ca href=\"#-features\"\u003e⚡Features\u003c/a\u003e •\n    \u003ca href=\"#-usages\"\u003e🔥Usages\u003c/a\u003e •\n    \u003ca href=\"#-installation\"\u003e🔨Installation\u003c/a\u003e •\n    \u003ca href=\"#-getting-started\"\u003e⭐Getting Started\u003c/a\u003e\n\u003c/p\u003e\n\nHave 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.\nThis 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!\n\u003cbr\u003e\n\n`ntfyme` stands for 'notify-me', obviously! So just write your command and pipe the notification of its Error(or Success) with ntfyme.\n\n## 📷 Previews\n\n### Command line Usage\n\nhttps://github.com/user-attachments/assets/a96a55be-7a38-45b8-999d-11742801aaa9\n\n\u003cbr\u003e\nYou can run any command, from regular command line to computational biology commands to any other!\n\n### Gmail\n\nYou can get texts for smaller outputs and text files for bigger outputs upto the limit GMAIL allows.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"701\" src=\"https://github.com/user-attachments/assets/b1fb9d6e-5a14-4e58-8c08-4473631880db\" alt=\"ntfyme_gmail1\"\u003e\n\u003c/p\u003e\n\n### Telegram bot messages\n\nAfter setting up your telegram bot, you can get similar outputs there too with NOTIFICATION.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/e9cc3b45-d657-452c-b2ee-a86a8e3abedb\" alt=\"Telegram bot preview\"\u003e\n\u003c/p\u003e\n\nand more ...\n\n## ⚡ Features\n\n- ✨ Very easy to use and setup.\n- ✨ Cross platform support for Windows, MacOS and Linux.\n- ✨ Get local notifications when your command is done.\n- ✨ Get notifications like gmail, telegram bot, etc. when your command is done.\n- ✨ Get information about output, errors, time taken, pid and more in the notification.\n- ✨ Track your process for possible suspensions and get notified after thorough diagnostics.\n- ✨ Enhanced UI features powered by rich and beaupy.\n\n## 🔥 Usages\n\nSay you want to run your terminal command called `\u003ccommand\u003e`, which can be running some python script, some shell scripts, or any terminal regular command.\n\nThere are mainly two ways to use the tool to get a notification -\n\n### 1. Direct Run\n\nFor \"direct running\", you can follow the below format -\n\n```bash\nntfyme exec -c \u003ccommand\u003e\n```\n\n### 2. Piping the command\n\nFor \"piping the command\", you can follow the below format -\n\n```bash\necho \u003ccommand\u003e | ntfyme exec\n```\n\nBoth the above commands will give the SAME output, a notification when the command is done.\n\n\u003e [!Note]\n\u003e\n\u003e For Windows, it is recommended to enclose you commands in double quotes. For example - `ntfyme exec -c \"echo hi\"`.\n\n### More examples\n\n1. To run multiple commands, you can use the `\"multiple commands\"` syntax to input to ntfyme. For example -\n\n```bash\necho \"echo hi; touch hello.txt; echo 'What a day!' \u003e hello.txt\" | ntfyme exec\n```\n\nThe net output will be outputted for such commands with an overall diagnostics instead of seperate for each command.\n\n2. Running ssh will not work with ntfyme. Although one can use it to test the connection and then run the command. For example -\n\n```bash\necho \"nmap 1.1.1.1 -p 22\" | ntfyme exec\n```\n\nThis command may take some time to run, but will give you a notification when the command is done.\n\n3. If you would like to get notifications for an ssh command, you would need to install `ntfyme` on the remote machine, give your gmail id and app password in the `config.toml`.\n\n## 🔨 Installation\n\nYou can install this tool with the below options available:\n\n### Pypi Installation\n\nYou can download this tool by running the below command -\n\n```bash\npip install ntfyme\n```\n\n\u003e [!Tip]\n\u003e\n\u003e For Windows, you may get a mesage to add `C:\\Users\\your\\path\\to\\Python31x\\Scripts`(whatever you get) to path, refer this [guide](https://stackoverflow.com/questions/44272416/how-to-add-a-folder-to-path-environment-variable-in-windows-10-with-screensho). Please add it to the path in order to run ntfyme.\n\n### Homebrew Installation(for MacOS)\n\nThis tool can downloaded from my Homebrew tap, by running the below command -\n\n```bash\nbrew install anirudhg07/anirudhg07/ntfyme\n```\n\n### Manual Installation\n\nYou can download the source code from the repository and run the below command to install the tool -\n\n```bash\ngit clone https://github.com/AnirudhG07/ntfyme.git\ncd ntfyme\npip install .\n```\n\n\u003e [!Important]\n\u003e\n\u003e WSL will be counted as windows instead of linux, thus notifications will be done through \"plyer\" library instead of linux notify-send. To complete the installation process for WSL, please run [wsl.sh](https://github.com/AnirudhG07/ntfyme/blob/main/docs/setup_guide/wsl.sh) script in your WSL terminal with sudo permissions. You can do this by running -\n\n```bash\nchmod +x wsl.sh\nsudo ./wsl.sh\n```\n\n## ⭐ Getting Started\n\nTo 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.\n\nTo know more about the `config.toml` and configurations, read below.\n\n## Configurations\n\n`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.\n\n`ntfyme` uses `on/off` to enable/disable ny settings. Please do not input any other values other than `on/off` for the `enabled` option. The comments for each option is mentioned, please read them before changing any option. They will give a thorough idea about the configurations and their usage.\nPlease do not mess around with the `config.toml` file, as it may lead to some errors in the tool.\n\n## Contribute\n\nYou are very welcome to contribute to this project. If you find bugs, or more API's for notifications, some more features, etc. feel free to create an issue, discuss and then make a PR. To make `ntfyme` better and used throughout the world, please star and share this repo to everyone!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanirudhg07%2Fntfyme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanirudhg07%2Fntfyme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanirudhg07%2Fntfyme/lists"}