{"id":19179809,"url":"https://github.com/hrntknr/ntf","last_synced_at":"2026-01-14T18:53:34.007Z","repository":{"id":49527033,"uuid":"294688670","full_name":"hrntknr/ntf","owner":"hrntknr","description":"A command line application to send notifications, on demand and when commands finish.","archived":true,"fork":false,"pushed_at":"2022-07-25T16:32:49.000Z","size":129,"stargazers_count":69,"open_issues_count":2,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-11T16:08:01.989Z","etag":null,"topics":["line","notifications","pushbullet","pushover","rust","slack"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hrntknr.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}},"created_at":"2020-09-11T12:24:15.000Z","updated_at":"2025-06-30T12:30:11.000Z","dependencies_parsed_at":"2022-09-21T12:13:37.467Z","dependency_job_id":null,"html_url":"https://github.com/hrntknr/ntf","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/hrntknr/ntf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrntknr%2Fntf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrntknr%2Fntf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrntknr%2Fntf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrntknr%2Fntf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hrntknr","download_url":"https://codeload.github.com/hrntknr/ntf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hrntknr%2Fntf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28430961,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T16:38:47.836Z","status":"ssl_error","status_checked_at":"2026-01-14T16:34:59.695Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["line","notifications","pushbullet","pushover","rust","slack"],"created_at":"2024-11-09T10:44:43.584Z","updated_at":"2026-01-14T18:53:33.992Z","avatar_url":"https://github.com/hrntknr.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ntf\n\n[![build](https://github.com/hrntknr/ntf/workflows/.github/workflows/build.yml/badge.svg)](https://github.com/hrntknr/ntf/actions?query=workflow%3A.github%2Fworkflows%2Fbuild.yml)\n\n`ntf` brings notification to your shell. This project was inspired by [ntfy](https://github.com/dschep/ntfy).\n\nCompared to ntfy, it has the following advantages\n\n- Works in a single binary\n- lightweight\n- No need to install additional plug-ins\n\nHowever, support for the backend type is poorer than ntfy.\n\n## Quickstart\n\n```sh\n$ # for linux\n$ sudo curl -L https://github.com/hrntknr/ntf/releases/download/v1.0.1/ntf-x86_64-unknown-linux-gnu -o /usr/local/bin/ntf\n$ # for mac\n$ # sudo curl -L https://github.com/hrntknr/ntf/releases/download/v1.0.1/ntf-x86_64-apple-darwin -o /usr/local/bin/ntf\n$ sudo chmod +x /usr/local/bin/ntf\n\n$ echo -e 'backends: [\"pushover\"]\\npushover: {\"user_key\": \"t0k3n\"}' \u003e ~/.ntf.yml\n$ # If you want to use slack, you can do the following\n$ # echo -e 'backends: [\"slack\"]\\nslack: {\"webhook: \"https://hooks.slack.com/services/hogehoge\"}' \u003e ~/.ntf.yml\n$\n$ # send message: \"test\"\n$ ntf send test\n$ # override default setting\n$ ntf send test --pushover.priority emergency --pushover.retry 60 --pushover.expire 3000\n$\n$ # exec command: `sleep 1` and send result\n$ ntf done sleep 1\n$\n$ # Enable shell integration\n$ echo 'export AUTO_NTF_DONE_LONGER_THAN=10' \u003e\u003e ~/.bashrc\n$ echo 'eval \"$(ntf shell-integration)\"' \u003e\u003e ~/.bashrc\n```\n\n```\n\u003e $ ntf --help\nUsage:\n   [command]\n\nAvailable Commands:\n  done              Execute the command and notify the message\n  help              Help about any command\n  send              send notification\n  shell-integration shell-integration\n\nFlags:\n  -h, --help   help for this command\n\nUse \" [command] --help\" for more information about a command.\n\n\u003e $ ntf send --help\nsend notification\n\nUsage:\n   send [flags]\n\nFlags:\n      --backends strings\n  -h, --help                       help for send\n      --line.token string\n      --pushbullet.token string\n      --pushover.device string\n      --pushover.expire int\n      --pushover.priority string\n      --pushover.retry int\n      --pushover.user_key string\n      --slack.color string\n      --slack.webhook string\n      --syslog.facility string\n      --syslog.severity string\n  -t, --title string               override title\n```\n\n## Supported backend\n\n### [slack: (webhook)](https://api.slack.com/messaging/webhooks)\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - slack\nslack:\n  webhook: 'https://hooks.slack.com/services/****'\n  color: '#ff0000' #option\n```\n\n### [discord: (Webhook compatible with slack)](https://discord.com/developers/docs/resources/webhook)\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - slack\nslack:\n  webhook: 'https://discordapp.com/api/webhooks/****/****/slack'\n  color: '#ff0000' #option\n```\n\n### [pushbullet](https://pushbullet.com/)\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - pushbullet\npushbullet:\n  token: '********************'\n```\n\n### [pushover](https://pushover.net/)\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - pushover\npushover:\n  user_key: '********************'\n  priority: 'emergency' #option (emergency|high|normal|low|lowest)\n  retry: 30 #option\n  expire: 3600 #option\n```\n\n### [line](https://notify-bot.line.me/)\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - line\nline:\n  token: '********************'\n```\n\n### syslog\n\n`~/.ntf.yml` example:\n\n```yml\nbackends:\n  - syslog\nsyslog:\n  facility: 'user' #option\n  severity: 'emerg' #option\n```\n\n## Custom backend\n\nYou can add the custom backend you want by simply creating a struct that implements the interface in the backends folder.  \nOr, submit a backend request that you would like to use via Issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhrntknr%2Fntf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhrntknr%2Fntf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhrntknr%2Fntf/lists"}