hpi_shell(1)

💅 hpi_shell(1) — the OpenHPI interactive playground 🎀

okay so bestie, welcome to hpi_shell, an OpenHPI sample application that lets you ~interactively~ do a whole bunch of HPI operations. it's giving "type stuff, poke at hardware, see what happens" energy ✨

---

🌸 SYNOPSIS 🌸

hpi_shell [-D nn] [-N host[:port]] [-C <cfgfile>] [-e] [-f <file>] [-X] [-h]
hpi_shell [--domain=nn] [--host=host[:port]] [--cfgfile=file] [--events] [--cmdfile=filename] [--debug] [--help]

like, pick your flags, bestie, and go 💅

---

🦋 DESCRIPTION 🦋

so here's the vibe: hpi_shell reads commands and then performs HPI operations based on whatever you told it. that's literally it, and it's iconic. this means you can use it to exercise your HPI-managed hardware and do manual operations on that hardware — no cap 🔥

once you're actually inside hpi_shell, type the "help" command to get a list of commands, or "help command" if you want the details on one particular command. iykyk 🫶

and here's the little detail to remember: if no domain or host is selected, ohparam uses the default domain as specified in the openhpiclient.conf file. periodt 💖

---

✨ OPTIONS ✨

🎀 Help Options:

• -h, --help — show help options. classic. we love a helpful queen 👑

🌈 Application Options:

• -f filename, --cmdfile=filename — execute command file. yes, it runs a whole file of commands for you 🍓
• -e, --events — show short events, and discover after subscribe 👀
• -D nn, --domain=nn — select domain id nn 🎯
• -X, --debug — display debug messages. for when you need to see everything, bestie 💀
• -N "host[:port]", --host="host[:port]" — open a session to the domain served by the daemon at the specified URL (host:port). this option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables. and listen: if host contains ':' (for example an IPv6 address) then enclose it in square brackets. for example: "[::1]" or "[::1]:4743". write that down 📝
• -C "file", --cfgfile="file" — use the passed file as the client configuration file. this option overrides the OPENHPICLIENT_CONF environment variable. slay 🧚

---

👑 SEE ALSO 👑

the whole friend group showed up, fr fr:

• hpialarms, hpifan, hpipower, hpithres
• hpidomain, hpigensimdata, hpireset, hpitop
• hpiel, hpiinv, hpisensor, hpitree
• hpievents, hpionIBMblade, hpisettime, hpiwdt
• hpixml
• ohdomainlist, ohhandler, ohparam

all of them, every last one, no crumbs left behind 💜

---

💖 AUTHORS 💖

the author(s) of this man page, aka the main characters who wrote this:

• Bryan Sutula (sutula@users.sourceforge.net)
• Ulrich Kleber (ulikleber@users.sourceforge.net)
• Anton Pak (avpak@users.sourceforge.net)

---

⭐ and that's the whole page, bestie! this is from OpenHPI 4.0.0, dated 2023-01-26 — go forth and run hpi_shell with main character energy 🦋💅🌸