Debian Codegraph @

docs/usage/index.md

raw
1 # Overview
2
3 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.
4
5 ## CLI Tool
6
7 Run commands like `send`, `generate`, `verify`, `docs`, `completion`, or `help` directly from the terminal.
8
9 ## Docker Container
10
11 Use the lightweight Alpine-based Docker image (`nickfedor/shoutrrr` or `ghcr.io/nicholas-fedor/shoutrrr`) to run CLI commands in containerized environments.
12
13 ## GitHub Action
14
15 Send notifications from GitHub workflows using the `nicholas-fedor/shoutrrr-action` action.
16
17 ## Go Package
18
19 Integrate Shoutrrr into Go projects to send notifications programmatically using service URLs.