urlwatch - Monitor webpages and command output for changes
Contents
Bug Tracker
https://github.com/thp/urlwatch/issues
Copyright
2024 Thomas Perl
urlwatch Oct 28, 2024 URLWATCH(1)
Description
urlwatch is intended to help you watch changes in webpages and get notified (via e-mail, in your terminal
or through various third party services) of any changes. The change notification will include the URL
that has changed and a unified diff of what has changed.
See urlwatch-intro(7) for a quick start guide and tutorial, and urlwatch-cookbook(7) for usage recipes
and tricks.
This manpage describes the CLI tool.
positionalarguments:JOB indexes or tags of job(s) to run. If --tags is set, each JOB is a tag, if not, each JOB is
an index numbered according to the --list command.
optionalarguments:-h, --help
show this help message and exit
--tags use tags instead of indexes to select jobs to run
--version
show program's version number and exit
-v, --verbose
show debug output
filesanddirectories:--urlsFILE
read job list (URLs) from FILE
--configFILE
read configuration from FILE
--hooksFILE
use FILE as hooks.py module
--cacheFILE
use FILE as cache database
Authentication:--smtp-login
Enter password for SMTP (store in keyring)
--xmpp-login
Enter password for XMPP (store in keyring)
--telegram-chats
List telegram chats the bot is joined to
--test-reporterREPORTER
Send a test notification
joblistmanagement:--list list jobs
--addJOB
add job (key1=value1,key2=value2,...)
--deleteJOB
delete job by location or index
--enableJOB
enable job by location or index
--disableJOB
delete job by location or index
--change_locationJOBNEW_LOCATION
change the location of an existing job by location or index
--test-filterJOB
test filter output of job by location or index
--test-diff-filterJOB
test diff filter output of job by location or index (needs at least 2 snapshots)
--dump-historyJOB
dump historical cached data for a job
interactivecommands($EDITOR/$VISUAL):--edit edit URL/job list
--edit-config
edit configuration file
--edit-hooks
edit hooks script
miscellaneous:--features
list supported jobs/filters/reporters
--gc-cacheRETAIN_LIMIT
remove old cache entries, keeping the latest RETAIN_LIMIT (default: 1)
Files
$XDG_CONFIG_HOME/urlwatch/urls.yaml
Configured job and filter list, see urlwatch-jobs(5) and urlwatch-filters(5)$XDG_CONFIG_HOME/urlwatch/urlwatch.yaml
Global and reporter settings, see urlwatch-config(5) and urlwatch-reporters(5)$XDG_CONFIG_HOME/urlwatch/hooks.py
A Python 3 module that can implement new job types, filters and reporters
$XDG_CACHE_HOME/urlwatch/cache.db
A SQLite 3 database (minidb) that contains the state history of jobs (for diffing)
Name
urlwatch - Monitor webpages and command output for changes
See Also
urlwatch-intro(7), urlwatch-cookbook(7), urlwatch-deprecated(7), urlwatch-jobs(5), urlwatch-filters(5), urlwatch-config(5), urlwatch-reporters(5)
Synopsis
urlwatch [options] [JOB ...]
Website
https://thp.io/2008/urlwatch/
