WAYPROMPT(1)

📦 version 0.1.2, in nixos 26.05

✨ wayprompt(1) — General Commands Manual, but make it a whole vibe ✨

🌸 NAME 🌸

okay so bestie, wayprompt is a prompt dialog tool for Wayland. That’s the whole NAME moment. 💅 It can display messages, optionally with buttons, and query for secrets. The wayland server has to support the wlr-layer-shell-unstable-v1 protocol extension — no cap.

The wayprompt executable described in this manual page is the command line version of wayprompt. The following other versions are available too:

All wayprompt versions use the same configuration file. Read wayprompt(5) for more information on configuring wayprompt. 🫶

✨ SYNOPSIS ✨

wayprompt [-h] [--help]

wayprompt [--title] [--description] [--prompt] [--error] [--button-ok] [--button-no-ok] [--button-cancel] [--wayland-display] [--get-pin] [--json]

💅 OPTIONS 💅

  • -h, --help — print help text and exit. Bye bestie! 👋
  • --title <string> — set the title of the dialog window. Main character title energy. 👑
  • --description <string> — set the main text of the dialog window. This is where the tea goes. 🍓
  • --prompt <string> — set the prompt over the pin area. This may only be specified in combination with --get-pin. Periodt.
  • --error <string> — set the error message displayed on the bottom of the dialog window. 😭
  • --button-ok <string> — set the text of the ok button. Note that the button is only displayed if text is set for it. No text, no button, iykyk.
  • --button-cancel <string> — set the text of the cancel button. Note that the button is only displayed if text is set for it. Same vibe check as above. ✨
  • --button-not-ok <string> — set the text of the not-ok button. Note that the button is only displayed if text is set for it. Again: text or it’s not showing up, fr fr.
  • --wayland-display <string> — set the wayland display name wayprompt should connect to. Note that normally wayprompt tries to get this from the WAYLAND_DISPLAY environment variable. 👀
  • --get-pin — activate the pin mode, allowing users to type a secret into wayprompt. Secretive. 🤫
  • --json — format output as JSON, useful for machine parsing. Robots love this one. 🤖

🌈 OUTPUT 🌈

wayprompt outputs status in a simple format to stdout. The first line will be

user-action: <status>

where <status> is one of either ok, not-ok or cancel. If --get-pin is used, making wayprompt prompt for a secret, then a second line is outputted. This is either

pin: <secret>

in the case of the ok button being used or the Enter key being pressed, where <secret> is the entered secret. Or alternatively

no pin

in the case of either the not-ok or cancel button being used, the Escape key being pressed, or the secret being empty on confirmation. 😌

🎀 RETURN VALUE 🎀

The command line version of wayprompt will exit with one of the following commands — iconic wording, I don’t make the rules:

  • 0 — The user triggered "ok" (by pressing Enter or clicking the button).
  • 10 — The user triggered "cancel" (by pressing Escape or clicking the button).
  • 20 — The user triggered "not-ok" (by clicking the button).
  • 1 — An error occured.
yes bestie, “occured” is literally what the page says — preserving the spelling exactly 😭

👑 AUTHOR 👑

Leon Henrik Plickat — the author. Slay. 💜

🦋 SEE ALSO 🦋

pinentry-wayprompt(1), wayprompt(5)

💖 source/version: git.sr.ht/~leon_plickat/wayprompt · date: 2023-06-03 · manual: WAYPROMPT(1) — mwah, bestie! 💖

📦 where this page comes from