URLWATCH(1)

💖 urlwatch — the manual page, but make it a group chat

okay so bestie, this is urlwatch(1) from the urlwatch Documentation, and I need you to sit down because this little tool is about to become your whole personality. ✨

---

🎀 NAME

urlwatch — monitor webpages and command output for changes 👀

---

🌸 SYNOPSIS

urlwatch [options] [JOB ...]

---

🦋 DESCRIPTION

so basically, urlwatch exists to help you watch changes in webpages and get notified about them — via e-mail, right there in your terminal, or through various third party services. that's it. that's the whole vibe. 💅

and when something changes, the notification is not gonna leave you guessing: it includes the URL that changed and a unified diff of what changed. iconic behaviour fr fr.

if you're brand new here, go read urlwatch-intro(7) for the quick start guide and tutorial, and urlwatch-cookbook(7) for usage recipes and tricks. this manpage right here? it describes the CLI tool. 🫶

✨ positional arguments

• 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. iykyk. 💜

✨ optional arguments

• -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 (for when you need to see everything) 👑

🍓 files and directories

• --urls FILE — read job list (URLs) from FILE
• --config FILE — read configuration from FILE
• --hooks FILE — use FILE as hooks.py module
• --cache FILE — 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-reporter REPORTER — send a test notification

📋 job list management

• --list — list jobs
• --add JOB — add job (key1=value1,key2=value2,...)
• --delete JOB — delete job by location or index
• --enable JOB — enable job by location or index
• --disable JOB — delete job by location or index

bestie i am reading this out loud exactly as written 💀 yes, --disable says delete. that's the manpage's words, not mine, i'm just the messenger.

• --change_location JOB NEW_LOCATION — change the location of an existing job by location or index
• --test-filter JOB — test filter output of job by location or index
• --test-diff-filter JOB — test diff filter output of job by location or index (needs at least 2 snapshots)
• --dump-history JOB — dump historical cached data for a job

🧚 interactive commands ($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-cache RETAIN_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)

---

🌟 SEE ALSO

urlwatch-intro(7), urlwatch-cookbook(7), urlwatch-deprecated(7), urlwatch-jobs(5), urlwatch-filters(5), urlwatch-config(5), urlwatch-reporters(5)

---

👑 AUTHOR

Thomas Perl <https://thp.io/>

🐛 BUG TRACKER

https://github.com/thp/urlwatch/issues

🌐 WEBSITE

https://thp.io/2008/urlwatch/

©️ COPYRIGHT

2024 Thomas Perl

---

and that's the whole thing, bestie — this page is urlwatch, from the urlwatch Documentation, dated Oct 28, 2024. go forth, monitor everything, and slay. periodt. 💅✨🦋