beeep Go Library

To use the beeep library in your Go project, install it using the following command:

go get -u github.com/gen2brain/beeep

Use beeep.Alert to send a notification that typically includes an icon from a file path. You can also set a global beeep.AppName to identify your application in the notification.

beeep.AppName = "My App Name"

err := beeep.Alert("Title", "Message body", "testdata/warning.png")
if err != nil {
    panic(err)
}

Use beeep.Beep to play an audible alert. It requires a frequency and a duration.

err := beeep.Beep(beeep.DefaultFreq, beeep.DefaultDuration)
if err != nil {
    panic(err)
}

Use beeep.Notify to send a desktop notification. It accepts a title, a message body, and an optional icon as a byte slice ([]byte).

//go:embed testdata/info.png
var icon []byte

err := beeep.Notify("Title", "Message body", icon)
if err != nil {
    panic(err)
}

You can use build tags to modify how beeep interacts with the system:

• nodbus: Disables godbus/dbus and forces the library to use only notify-send for notifications.