RQWORKER(1)

🎀 NAME 🎀

okay so rqworker is your girl — she's a command line monitor to start an RQ worker 💅 and she lives in section 1 of the General Commands Manual, so when you see rqworker(1) out in the wild, that's her, that's the one ✨

---

🦋 SYNOPSIS 🦋

rqworker [OPTIONS] [QUEUES]...

like, give her some options, give her some queues, she'll handle it 🫶

---

🌸 DESCRIPTION 🌸

So rqworker is a command-line monitor that starts up an RQ worker. She's part of the python-rq module package, iykyk 💜

And what is a worker, you ask? Bestie. A worker is a Python process that typically runs in the background and exists solely as a work horse 🐴 to perform all those lengthy or blocking tasks that you absolutely do not want to be doing inside your web processes. She's the main character doing the heavy lifting so your web app can stay cute and unbothered 🌈✨

---

✨ OPTIONS ✨

okay this is the part where you take notes, bestie, because there are a LOT of them and every single one is here, no cap 📝

• -b, --burst — Run in burst mode (quit after all work is done) 🏃‍♀️💨
• --logging_level TEXT — Set logging level
• --log-format TEXT — Set the format of the logs
• --date-format TEXT — Set the date format of the logs
• -n, --name TEXT — Specify a different name 🏷️
• --results-ttl INTEGER — Default results timeout to be used
• --worker-ttl INTEGER — Default worker timeout to be used
• --maintenance-interval-ttl INTEGER — Maintenance task interval (in seconds) to be used
• --job-monitoring-interval INTEGER — Default job monitoring interval to be used
• --disable-job-desc-logging — Turn off description logging.
• -v, --verbose — Show more output 🗣️
• -q, --quiet — Show less output 🤫
• --sentry-ca-certs TEXT — Path to CRT file for Sentry DSN
• --sentry-debug TEXT — Enable debug
• --sentry-dsn TEXTR — Report exceptions to this Sentry DSN
• --exception-handler TEXT — Exception handler(s) to use
• --pid TEXT — Write the process ID number to a file at the specified path
• -d, --disable-default-exception-handler — Disable RQ's default exception handler
• --max-jobs INTEGER — Maximum number of jobs to execute
• --max-idle-time INTEGER — Maximum seconds to stay alive without jobs to execute ⏳
• -s, --with-scheduler — Run worker with scheduler
• -S, --serializer TEXT — Run worker with custom serializer
• -ds, --dequeue-strategy TEXT — Sets a custom stratey to dequeue from multiple queues
• -S, --serializer TEXT — Path to serializer, defaults to rq.serializers.DefaultSerializer
• -P, --path TEXT — Specify the import path.
• --connection-class TEXT — Redis client class to use
• --queue-class TEXT — RQ Queue class to use
• -j, --job-class — RQ Job class to use
• -w, --worker-class TEXT — RQ Worker class to use
• -c, --config TEXT — Module containing RQ settings.
• -u, --url TEXT — URL describing Redis connection details.
• --help — Show help message and exit.

💀 bestie not me noticing a couple of lil quirks in the source: -S, --serializer is listed twice (once as "Run worker with custom serializer", once as "Path to serializer, defaults to rq.serializers.DefaultSerializer"), the dequeue strategy one says "stratey", --sentry-dsn takes TEXTR, and the -j, --job-class line has its placeholder all smooshed up against the description as TEXTRQ Job class to use. We're reporting, not fixing — the facts stay exactly as written 🙈

---

🔥 SEE ALSO 🔥

• rq(1)
• rqinfo(1)
• Full rq documentation 📚

---

and that's the whole page, periodt 💖 this one came out of User Commands — RQWORKER(1), section 1, General Commands Manual, authored under the python-rq crew's name and shipped with the package, dated however old your copy is 🎀 go start a worker and slay, bestie 👑🦋