PUMA(1)

💖 NAME 💖

okay so bestie, pumactl — that's the command line client for puma. that's the whole vibe. it's how you talk to your puma server without, like, touching it directly. iykyk ✨

🌸 USAGE 🌸

here's the shape of it, fr fr:

pumactl [options...] [commands]

and if you just wanna vibe-check it:

pumactl [-h | --help | -V | --version]

🎀 COMMANDS 🎀

these are the moves, bestie. pick one. 💅

• halt — halt the server. like, full stop. no notes.
• restart — restart the server. iconic, classic, we love her.
• phased-restart — restart the server but do it ✨gracefully✨: it phases out the old workers while starting up new workers one at a time. no chaos, just vibes.
• start — start the server. get her going.
• stats — show stats about the server. the receipts, basically.
• status — show server status. is she okay? let's find out.
• stop — stop the server. bye bestie 🫶
• reload-worker-directory — reload the worker directory. simple as that.
• gc — start the garbage collector. she's cleaning up, periodt.
• gc-stats — show information about the garbage collector. the cleanup receipts. 💀

✨ OPTIONS ✨

the following options are available, and yes you need to know all of them, no skipping 🙈:

• -F, --config-file PATH — load the given path as a config file. feed her the file, she'll read it.
• -T, --control-token TOKEN — the TOKEN to use as authentication for the control server. it's the password, basically, so guard it.
• -C, --control-url URL — the bind URL to use for the control server and app. use auto to use a temp unix server. > ⚠️ this requires you to use a --control-token, and that token needs to be given with every request to the control server — like token=foo. no token, no entry, no cap.
• -p, --pid PID — define the TCP port to bind to. use -b for more advanced options.
• -P, --pidfile PATH — use the given path as PID file. that's where the pid lives.
• -Q, --quiet — don't display messages. silence, but make it intentional. 🤫
• -S, --state PATH — where the state file is. point her at it.
• -H, --help — show help. when in doubt, ask for help bestie, it's free.
• -V, --version — print the version information. so you know exactly what you're working with. 💖

🦋 EXAMPLES 🦋

okay so here's the main character moment: create a control server, then use pumactl(1) to interact with the control server and restart puma. literally the whole point. ⭐

puma --control-url tcp://127.0.0.1:9293 --control-token foo
pumactl --control-url 'tcp://127.0.0.1:9293' --control-token foo
restart

see how the token foo shows up both times? that's the vibe. 🌈

👑 SEE ALSO 👑

• puma(1) — the main character herself.

there is extensive documentation at <https://puma.io/puma/> and <https://github.com/puma/puma>. go read it, i'm begging 🧚

💜 AUTHOR 💜

this manual page was written by Daniel Leidert <dleidert@debian.org>, for the Debian GNU/Linux system (but may be used by others). king behavior honestly. 👑

and that's the whole page bestie — this is PUMA 3.12, dated January 2020, and it ate, no crumbs. slay 💅🎀💖