man(8)

πŸ’– wait-for-it β€” the man page but make it slay πŸ’–

okay bestie, so this is man(8) β€” section 8 of the manual, the "system administration / daemons and stuff" section, iykyk. It's the page for wait-for-it, and honestly? She's iconic. Let's get into it. πŸŽ€


✨ NAME ✨

wait-for-it β€” a script that tests and waits on the availability of a TCP host and port πŸ¦‹


✨ SYNOPSIS ✨

wait-for-it host:port [-s] [-t timeout] [-- command args]

that's it. that's the whole vibe. πŸ’…


✨ DESCRIPTION ✨

wait-for-it is a pure bash script that will wait on the availability of a host and TCP port. 🌸

The way this is SO useful: it's for synchronizing the spin-up of interdependent services β€” like, think linked docker containers, where one thing literally cannot start until its bestie is up and listening. 🫢

And because she's a pure bash script, she has no external dependencies at all. No extra packages, no drama, no "oops you need to install this first." Just bash. Periodt. πŸ’€βœ¨


✨ OPTIONS ✨

  • -h HOST, --host=HOST β€” the host or IP you're putting under test πŸ‘‘
  • -p PORT, --port=PORT β€” the TCP port under test πŸ”Œ
  • -s, --strict β€” only execute the subcommand if the test actually succeeds. no success, no run. strict queen behavior 😀
  • -q, --quiet β€” don't output any status messages. silent. mysterious. lowkey 🀫
  • -t TIMEOUT, --timeout=TIMEOUT β€” timeout in seconds, and zero means no timeout (as in, she will wait forever, bestie, she is patient) ⏳
  • -- COMMAND ARGS β€” execute the command with its args after the test finishes πŸƒβ™€οΈπŸ’¨

✨ AUTHOR ✨

Giles Hall 🌈


and that's the whole page, no cap. This one's rocking version 1.0, dated 29 April 2016 β€” an absolute vintage icon, she was slaying before most of us even had a terminal open πŸ’…βœ¨ mwah, go wait on that port bestie πŸ’–πŸ¦‹