oct(1)

πŸ“¦
version 0.11.13 Β· 2 versions
, in arch rolling, nixpkgs unstable

πŸ™ oct(1) β€” bestie's guide to OpenPGP cards πŸ’³βœ¨

okay so welcome to oct(1), straight out of the General Commands Manual section β€” like, that's the manual this page lives in, iykyk. no cap, this is the tool you want when you're inspecting, configuring and using OpenPGP cards. let's get into it 🫢


✨ SYNOPSIS ✨

oct [--output-format] [--output-version] [-h|--help] [-V|--version]
<subcommands>

that's the whole shape of it β€” some flags, then a subcommand, and the subcommands are where the real main character energy lives. πŸ’…


🌸 DESCRIPTION 🌸

A tool for inspecting, configuring and using OpenPGP cards.

literally that's the whole pitch, and honestly? it ate. πŸŽ€


πŸ’… OPTIONS πŸ’…

  • --output-format <OUTPUT_FORMAT> [default: text] β€” produce output in the chosen format. the possible values are, and I need you to remember these exactly:
    • json
    • text
    • yaml
  • --output-version <OUTPUT_VERSION> [default: 0.11.0] β€” pick which output version to use. heads up though, this one's for the non-textual formats only, so don't come for it when you're in plain text mode. 😌
  • -h, --help β€” print help. the classic. the icon. 🫢
  • -V, --version β€” print version. 🏷️

πŸ¦‹ SUBCOMMANDS πŸ¦‹

okay so this is the juicy part, each of these has its own manpage, so like, go read those for the deep lore πŸ‘‘

  • oct-list(1) β€” enumerate available OpenPGP cards. like a vibe check but for cards, it tells you who's in the room ✨
  • oct-status(1) β€” show information about the data on a card. what's on there, bestie? πŸ‘€
  • oct-info(1) β€” show technical details about a card. the nerdy deep-dive, we love her 🧚
  • oct-ssh(1) β€” show a card's authentication key as an SSH public key. yes, that kind of SSH, slay πŸ”‘
  • oct-pubkey(1) β€” export the key data on a card as an OpenPGP public key. sharing is caring πŸ’–
  • oct-admin(1) β€” administer data on a card (including keys and metadata). this is the whole backstage pass 🎟️
  • oct-pin(1) β€” PIN management (change PINs, reset blocked PINs). forgot it? blocked? she can fix that πŸ™ˆ
  • oct-decrypt(1) β€” decrypt data using a card. πŸ”“
  • oct-sign(1) β€” sign data using a card. ✍️ periodt
  • oct-attestation(1) β€” attestation management. Yubico only, and I'm not being cute about that, it's literally Yubico only ⚠️
  • oct-system(1) β€” initialization and similar functionality. the "let's set things up" girlie πŸ› οΈ
  • oct-output-versions(1) β€” show supported output format versions. so you know what's valid before you pick one 🌈
  • oct-help(1) β€” print this message or the help of the given subcommand(s). the helpful one, honestly iconic 😭

🌟 VERSION 🌟

v0.11.13

πŸ‘‘ AUTHORS πŸ‘‘

Heiko Schaefer <heiko@schaefer.name> β€” thank you for your service, king 🫑


ngl, the flags are simple but the subcommands are the whole personality. read the individual manpages, don't guess, and you'll be fine πŸ’€

and that's the page, bestie! πŸŽ€ this whole thing comes to you from oct version 0.11.13 β€” so if something acts different on another version, that's between you and that version, fr fr. bye, love u, go inspect some cards πŸ’œπŸŒˆβœ¨

πŸ“¦ where this page comes from