Overview

Shoutrrr enables sending notifications to various services (e.g., Discord, Slack, Telegram) and can be used as a CLI tool, Go package, Docker container, or GitHub Action.

CLI Tool

Run commands like send, generate, verify, docs, completion, or help directly from the terminal.

Docker Container

Use the lightweight Alpine-based Docker image (nickfedor/shoutrrr or ghcr.io/nicholas-fedor/shoutrrr) to run CLI commands in containerized environments.

GitHub Action

Send notifications from GitHub workflows using the nicholas-fedor/shoutrrr-action action.

Go Package

Integrate Shoutrrr into Go projects to send notifications programmatically using service URLs.