/web-watcher

A discord bot which monitor and send alerts on website changes.

Primary LanguageGoMIT LicenseMIT

Gopher

web-watcher

A small Discord bot which aims to alert you on website changes.

Go version

Recent Update

Due to Discord API changes, please make sure to enable your Discord Bot Message Content Intent permission to work and be able to read Discord commands.

Bot Privilege

More instructions here: https://shellbear.github.io/web-watcher/requirements/

Documentation

A full documentation is available at https://shellbear.github.io/web-watcher.

Usage

> web-watcher --help
Web-watcher discord Bot.

Options:
  -delay int
        Watch delay in minutes (default 60)
  -prefix string
        The discord commands prefix (default "!")
  -ratio float
        Changes detection ratio (default 1)
  -token string
        Discord token

By default, the watch interval for every website is 1 hour, but you can easily change this with the interval parameter followed by the interval in minutes.

export DISCORD_TOKEN=YOUR_DISCORD_TOKEN
# Set watch interval to 10 minutes, defaults to 60 minutes
web-watcher --interval 10

# OR

# Set watch interval to 10 minutes, defaults to 60 minutes
web-watcher --token YOUR_DISCORD_TOKEN --interval 10

Discord commands

!watch [URL]

Add a URL to the watchlist.

!unwatch [URL]

Remove a URL from the watchlist.

!watchlist

Get the complete watchlist.

Built With

  • go-difflib - Partial port of Python difflib package to Go
  • xxhash - Go implementation of the 64-bit xxHash algorithm (XXH64)
  • Gorm - The fantastic ORM library for Golang
  • DiscordGo - Go bindings for Discord

License

This project is licensed under the MIT License - see the LICENSE file for details