id = "apprise"
name = "Apprise"
homepage = "https://appriseit.com"
description = "Apprise is an open-source notification library that makes it easy to send notifications to all of your favorite apps and services."
executables = ["apprise"]
[dotfiles]
paths = []
secret = [
"~/.apprise",
"~/.apprise.conf",
"~/.apprise.yml",
"~/.apprise.yaml",
"~/.config/apprise",
"~/.config/apprise.conf",
"~/.config/apprise.yml",
"~/.config/apprise.yaml",
"%APPDATA%/Apprise/apprise",
"%APPDATA%/Apprise/apprise.conf",
"%APPDATA%/Apprise/apprise.yml",
"%APPDATA%/Apprise/apprise.yaml",
"%LOCALAPPDATA%/Apprise/apprise",
"%LOCALAPPDATA%/Apprise/apprise.conf",
"%LOCALAPPDATA%/Apprise/apprise.yml",
"%LOCALAPPDATA%/Apprise/apprise.yaml",
]
[commands]
format = 1
label = "Send notification"
description = "Send a notification to one or more Apprise service URLs. Storage, plugin and recursion options are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }
[[commands.source]]
id = "help"
kind = "help"
url = "https://raw.githubusercontent.com/caronc/apprise/master/apprise/cli.py"
evidence = """
"--body",
"-b",
help="Specify the message body. If no body is specified then content is read from <stdin>."
"--title",
"-t",
help="Specify the message title. This field is completely optional."
"--config",
"-c",
help="Specify one or more configuration locations."
"--attach",
"-a",
help="Specify one or more attachments."
"--notification-type",
"-n",
help="Specify the message type"
"--input-format",
"-i",
help="Specify the message input format"
"--tag",
"-g",
help="Specify one or more tags to filter which services to notify."
"--dry-run",
"-d",
help="Perform a trial run but only prints the notification services to-be triggered to stdout. Notifications are never sent using this mode."
"--verbose",
"-v",
help="Makes the operation more talkative. Use multiple v to increase the verbosity. I.e.: -vvvv"
"--interpret-escapes",
"-e",
help="Enable interpretation of backslash escapes"
"""
[[commands.field]]
id = "urls"
label = "Service URLs"
description = "Notification service URLs. Omit when using a configuration file."
type = "string"
position = 0
multiple = true
sources = ["help"]
[[commands.field]]
id = "body"
label = "Message body"
description = "Read from standard input when empty."
type = "string"
option = ["--body", "-b"]
sources = ["help"]
[[commands.field]]
id = "title"
label = "Title"
type = "string"
option = ["--title", "-t"]
sources = ["help"]
[[commands.field]]
id = "notification_type"
label = "Notification type"
type = "string"
option = ["--notification-type", "-n"]
suggestions = [{ value = "info", label = "Info" }, { value = "success", label = "Success" }, { value = "warning", label = "Warning" }, { value = "failure", label = "Failure" }]
sources = ["help"]
[[commands.field]]
id = "input_format"
label = "Input format"
type = "string"
option = ["--input-format", "-i"]
suggestions = [{ value = "text", label = "Text" }, { value = "markdown", label = "Markdown" }, { value = "html", label = "HTML" }]
sources = ["help"]
[[commands.field]]
id = "config"
label = "Configuration location"
type = "string"
option = ["--config", "-c"]
multiple = true
sources = ["help"]
[[commands.field]]
id = "attach"
label = "Attachment"
type = "string"
option = ["--attach", "-a"]
multiple = true
sources = ["help"]
[[commands.field]]
id = "tag"
label = "Tag"
description = "Only notify services with this tag."
type = "string"
option = ["--tag", "-g"]
multiple = true
sources = ["help"]
[[commands.field]]
id = "dry_run"
label = "Dry run"
description = "List the services that would be notified without sending."
type = "boolean"
option = ["--dry-run", "-d"]
sources = ["help"]
[[commands.field]]
id = "interpret_escapes"
label = "Interpret backslash escapes"
type = "boolean"
option = ["--interpret-escapes", "-e"]
sources = ["help"]
[[commands.field]]
id = "verbose"
label = "Verbosity"
type = "count"
option = ["--verbose", "-v"]
sources = ["help"]
[[commands.task]]
id = "send"
label = "Send a message"
fields = ["urls", "body", "title", "notification_type", "tag", "attach"]
required = ["urls", "body"]
[[commands.task]]
id = "dry-run"
label = "Dry run with config"
set = { dry_run = [true] }
fields = ["config", "tag", "dry_run", "verbose"]
required = ["config"]
[[commands.group]]
id = "basic"
label = "Basic"
fields = ["urls", "body", "title", "notification_type", "tag", "dry_run"]
[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["input_format", "config", "attach", "interpret_escapes", "verbose"]
