CLOCKWORKD(1)

✨ CLOCKWORKD ✨

okay bestie, welcome to the clockworkd page — it lives in the clockwork manual and honestly? it's giving little daemon that could 💅

🌸 NAME 🌸

clockworkd — the daemon that runs your clockwork scripts, no cap. Like, it just executes them, in the background, forever, like a lil guy doing cardio 🏃♀️

---

🦋 SYNOPSIS 🦋

clockworkd [-c FILE] [OPTIONS] {start|stop|restart|run}

so you pass it a file if you want, some options if you want, and then you tell it one of four words: start, stop, restart, or run. that's the whole vibe check. pick one. 👑

---

💖 DESCRIPTION 💖

clockworkd executes clockwork script as a daemon. that's it, that's the job, and it slays at it ✨

but listen — you will need the daemons gem to use clockworkd. it is not automatically installed. please install it by yourself, bestie, nobody's gonna do it for you 😭 it's a whole DIY moment.

---

🎀 OPTIONS 🎀

okay this is the part where you actually read, because there's a lot and every single one matters 🫶

• --pid-dir=DIR — alternate directory in which to store the process ids. the default is GEM_LOCATION/tmp. so like, if you wanna put your pids somewhere else, this is your girl 💜
• -i, --identifier=STR — an identifier for the process. default is the clock file name. it's basically a little name tag for your process 🏷️
• -l, --log — redirect both STDOUT and STDERR to a logfile named clockworkd[.identifier].output in the pid-file directory. yes both. everything. into the log. 📝
• --log-dir=DIR — a specific directory to put the log files into. default location is the pid directory. so if you don't say anything, logs go hang out with the pids 🍓
• -m, --monitor — start monitor process. it's watching 👀 iconic behaviour honestly
• -c, --clock=FILE — clock .rb file. default is GEM_LOCATION/clock.rb. that's your actual script, your main character 🌟
• -d, --dir=DIR — directory to change to once the process starts. like, the process gets a new home 🏠
• -h, --help — show help message. the classic. the people's option 🙈

---

💀 BUGS 💀

found a bug? bestie, please create an issue at https://github.com/tomykaira/clockwork/issues. we wanna know. spill. 🫶

and if it's a bug fix or a feature request, please send a pull-request. but do not forget to add tests to show how your feature works, or what bug is fixed. no test, no vibe. and here's the thing: all existing tests and new tests must pass. TravisCI is watching 👁️👄👁️ it sees everything. it's literally always watching.

---

👑 AUTHORS 👑

• Created by Adam Wiggins. 🫡
• Inspired by rufus-scheduler and resque-scheduler. 💡
• Design assistance from Peter van Hardenberg and Matthew Soldo. 🎨
• Patches contributed by Mark McGranaghan and Lukáš Konarovský. 🩹

collab of the century fr fr.

---

🌈 SEE ALSO 🌈

• https://github.com/tomykaira/clockwork. go look. go read. go click. ✨

---

and that's the whole page, babes — this one shipped as a Ruby Gem back in August 2014, and it's still out here executing clockwork scripts as a daemon. periodt. 💅🎀🦋