@@ 1,9 1,8 @@
-
<img src="https://git.sr.ht/~bayindirh/nudge/blob/master/doc/assets/nudge_logo.png" alt="nudge logo" height="115">
# nudge - A Pushover CLI
-**Current state:** Very alpha. Can be used reliably to send messages, but command line interface and configuration file is not stable.
+**Current state:** *Almost beta*. Can be used reliably to send messages daily, but things may still change, esp. command line arguments.
nudge provides a small command line tool to send push notifications over
[Pushover](https://pushover.net). It aims to provide a simple and composable
@@ 47,28 46,37 @@ Message titles are set to sender's `hostname` by default, but can be changed. Me
Current options are as follows:
```
+-config_path string
+ Define or override configuration file path.
-devices string
- List of devices to be notified. Separate multiple devices with ','. (default "all")
+ List of devices to be notified. Separate multiple devices with ','. (default "all")
-dryrun
- Simulate sending a notification.
+ Simulate sending a notification.
+-log_level string
+ Change the logging level.
-priority int
- Adjust notification priority. Between -2 and 2. (default 0)
+ Adjust notification priority. Between -2 and 2. (default 0)
-sound string
- Set notification sound. (default "pushover")
+ Set notification sound. (default "pushover")
-title string
- Notification title. Hostname is used if omitted. (default "Hakans-MacBook-Pro.local")
+ Notification title. Hostname is used if omitted. (default "temple")
-url string
- An optional URL to attach to the notification.
+ An optional URL to attach to the notification.
-url_title string
- An optional title for URL to send.
+ An optional title for URL to send.
-version
- Print version and exit.
+ Print version and exit.
```
+## What's new in 0.2
+
+- Configuration file can be overloaded via command line.
+- Logging level can be configured via config file and command line.
+
## Known Issues
-- It's not possible to override configuration file location in this version.
-- Logging subsystem is not configurable yet. Options in the configuration file are not handled.
+- Logs can't be redirected to files via configuration file or command line, yet. These options are not handled in the code.
+- Configuration sanity checking doesn't check everything for acceptable values.
- Not all features provided by Pushover is implemented (image attachments, HTML formatting, and possibly others)
## Other Details