Skip to content
/ nottif Public

CLI tool to send markdown messages as notifications to Discord via Webhooks.

License

Notifications You must be signed in to change notification settings

Tanq16/nottif

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NOTTIF Logo

Release Build Latest Release


Nottif is a command-line tool that sends Discord webhook notifications for given markdown messages.

Installation

Download the latest release binary for your platform from the releases page. The tool is available for Linux, macOS, and Windows on both AMD64 and ARM64 architectures.

OR, use go install github.com/tanq16/nottif@latest to install with Go 1.23+.

Usage

Nottif can be used in two primary modes: command execution monitoring and raw message sending.

For command execution:

# Send a message
nottif -m "# Task completed"

# Pipe text to send it
echo "Test\nWebhook" | nottif -w $WEBHOOKURL

For persistent webhooks, create a file in any of these locations with a list of webhooks:

  • ~/.nottif.webhook
  • /persist/.nottif.webhook
  • ~/.config/.nottif.webhook

It will send to all the webhooks. If -w is used, it's only sent to that one URL.

Tip

Nottif sends the message as text, but Discord interprets it as Markdown. So you can get creative with custom messages! Just be mindful that Discord Markdown has a limited syntax.

Example

Using the following command:

printf "# Test\nData as discord markdown \`\`\`bash\nfor i in \$(ls)\ndo\n    echo \$i\ndone\n\`\`\`\n\nBullet lists are also supported -\n- item 1\n- \`inline code\` item 2\n- **bold** item 3\n\n[Notiff](/~https://github.com/tanq16/nottif) is a GitHub link\!" | nottif

gives the following result:

About

CLI tool to send markdown messages as notifications to Discord via Webhooks.

Topics

Resources

License

Stars

Watchers

Forks

Languages