From afc8f2289dbbdef22ae35c14f5ca33db55090323 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Mon, 30 Sep 2019 12:56:14 -0400 Subject: [PATCH] Created CLI_Usage (markdown) --- CLI_Usage.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CLI_Usage.md diff --git a/CLI_Usage.md b/CLI_Usage.md new file mode 100644 index 0000000..1dca63d --- /dev/null +++ b/CLI_Usage.md @@ -0,0 +1,25 @@ +## Apprise CLI +This small tool wraps the apprise python library to allow individuals such as Developers, DevOps, and Administrators to send notifications from the command line. + +Apprise in it's most basic form requires that you provide it a message and an Apprise URL which contains enough information to send the notification with. +```bash +# Set a notification to a hotmail (email) account: +python apprise --body="My Message" mailto://user:password@hotmail.com +``` + +If you don't specify a **--body** (**-b**) then Apprise reads from **stdin** instead: +```bash +# without a --body, you can use a pipe | to redirect output +# into you're notification: +uptime | python apprise mailto://user:password@hotmail.com +``` + +There is no limit to the number of services you want to notify, just keep adding/chaining them one after another: +```bash +# Set a notification to a yahoo email account, Slack, and a Kodi Server: +python apprise --body="Notify more than one service" \ + mailto://user:password@yahoo.com \ + slack://token_a/token_b/token_c \ + kodi://example.com +``` +