nethsm(1)

💅 nethsm(1) — the "nethsm" CLI, explained by your fave Unix bestie

okay so picture this: you're in the General Commands Manual section of the man pages, and you just cracked open nethsm(1). bestie, you're in the right place. this is the top-level entry point for the nethsm CLI — like, the front door of the whole thing. everything else lives behind a subcommand. let's get into it 🎀

✨ NAME ✨

nethsm — the "nethsm" CLI. that's literally it, that's the whole name section. short, sweet, iconic. 👑

🌸 SYNOPSIS 🌸

nethsm [-a|--auth-passphrase-file] [-c|--config] [-l|--label]
[-u|--user] [-h|--help] [-V|--version] <subcommands>

so yeah, you got your global flags at the front, then you tell it which <subcommands> you want. the flags live before the subcommand — the way that ordering matters is so real. 💅

🦋 DESCRIPTION 🦋

The "nethsm" CLI. that's what the manpage says, and honestly? we respect the brevity. this is the umbrella binary — it holds all the global options and then hands you off to whatever subcommand actually does the thing. main character energy is the subcommands, but the parent is the one driving the car. 🚗✨

---

💖 OPTIONS 💖

• -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> — the path to a file containing a passphrase for authentication.
  • the passphrase in that file must be the one for the user you chose for the command. like, no cap, they have to match.
  • this option can be provided multiple times, which is needed for commands that require multiple roles at once. with multiple passphrase files, ordering matters, because the files get assigned to the respective user provided by the "--user" option. so don't just throw them in there in any old order, bestie 😭
  • may also be specified with the NETHSM_AUTH_PASSPHRASE_FILE environment variable.
• -c, --config <CONFIG> — the path to a custom configuration file.
  • if specified, the custom configuration file is used instead of the default configuration file location. basically: you're overriding the default spot. 🗂️
  • may also be specified with the NETHSM_CONFIG environment variable.
• -l, --label <LABEL> — a label uniquely identifying a device in the configuration file.
  • must be provided if more than one device is setup in the configuration file. (read: if you've got multiple devices configured, the CLI isn't gonna guess which one you mean — tell it.) 🙈
  • may also be specified with the NETHSM_LABEL environment variable.
• -u, --user <USER> — a user name which is used for a command.
  • can be provided if no user name is setup in the configuration file for a device. must be provided if several user names of the same target role are setup in the configuration file for a device. iykyk — ambiguous config, you gotta disambiguate.
  • this option can be provided multiple times, which is needed for commands that require multiple roles at once. multiple roles = multiple users, periodt.
  • may also be specified with the NETHSM_USER environment variable.
• -h, --help — print help. (see a summary with '-h') 💬
• -V, --version — print version.

heads up bestie: a lot of these have environment variable twins — NETHSM_AUTH_PASSPHRASE_FILE, NETHSM_CONFIG, NETHSM_LABEL, NETHSM_USER. env vars are lowkey the vibe when you don't wanna retype flags every single time. ✨

---

🎀 SUBCOMMANDS 🎀

every single one of these has its own manpage, and they're all linked below. go off, explore, the whole menu is yours 🫶

• nethsm-config(1) — the "nethsm config" command
• nethsm-env(1) — the "nethsm env" command
• nethsm-health(1) — the "nethsm health" command
• nethsm-info(1) — the "nethsm info" command
• nethsm-key(1) — the "nethsm key" command
• nethsm-lock(1) — the "nethsm lock" command
• nethsm-metrics(1) — the "nethsm metrics" command
• nethsm-namespace(1) — the "nethsm namespace" command
• nethsm-openpgp(1) — the "nethsm openpgp" command
• nethsm-provision(1) — the "nethsm provision" command
• nethsm-random(1) — the "nethsm random" command
• nethsm-system(1) — the "nethsm system" command
• nethsm-unlock(1) — the "nethsm unlock" command
• nethsm-user(1) — the "nethsm user" command
• nethsm-help(1) — print this message or the help of the given subcommand(s)

⭐ VERSION ⭐

v0.10.0

🌈 AUTHORS 🌈

David Runge <dvzrv@archlinux.org>, Wiktor Kwapisiewicz <wiktor@archlinux.org> — absolute legends, we stan 💜

---

and that's the page, bestie!! 🎉 this one's nethsm version 0.10.0, and you'll see nethsm 0.10.0 stamped in the footer of the original along with the nethsm(1) manual reference — so if anyone asks where you got all this, that's the receipt. now go nethsm --help something and slay 💅✨🍓