KEYRING(1)

💖 KEYRING(1) 💖

okay bestie, sit down, hydrate, and let me tell you about keyring — it's the command-line utility from Python-Keyring, and it lives in the General Commands Manual. it's giving ✨password-management main character energy✨ and honestly? obsessed.

---

🌸 NAME 🌸

keyring — Python-Keyring command-line utility 🎀

---

✨ SYNOPSIS ✨

keyring [OPTIONS] [get|set|del|diagnose] SERVICE USERNAME

like, that's the whole vibe. options, then one of the actions, then the service and the username. simple, clean, slay 🫶

---

👑 OPTIONS 👑

every single one, no gatekeeping, periodt:

• -h, --help — shows you the help message and then dips out (exit). 💅
• -p KEYRING_PATH, --keyring-path=KEYRING_PATH — tells it the path to the keyring backend you wanna use. like a lil address for your backend, iykyk 🏠
• -b KEYRING_BACKEND, --keyring-backend=KEYRING_BACKEND — same idea but you're naming the backend by name instead of by path. pick your fighter ✨
• --list-backends — lists all the available keyring backends and then exits. a lil menu, a lil fashion show of backends 🌈
• --disable — creates a configuration file that disables keyring entirely, then exits. it's literally the "not today" button 💀
• --mode {password,creds} — sets the mode for the get operation.
  • password — requires a username and returns only the password.
  • creds — does not require a username and returns both the username and the password, separated by a newline.
  • the default is password. 🍓
• --output {plain,json} — sets the output format for the get operation. default is plain. 🎀
• --print-completion {bash,zsh,tcsh} — prints a shell completion script for whichever of bash, zsh or tcsh you asked for. tab-tab-tab your way to greatness ✨

---

🦋 DESCRIPTION 🦋

keyring gives you a way to store, look up and delete passwords across all the various backends that Python-Keyring supports. it's the plug between you and your secrets, and it's doing it flawlessly fr fr 💜

here's the usage example, verbatim, no edits, because it's iconic:

$ keyring set service username
Password for 'username' in 'service':
$ keyring get service username
password

see how the set one asks you for the password and the get one just hands it back to you? that's the whole circle of life 😭🫶

now, the important part — how SERVICE and USERNAME actually get handled depends on the backend. with the default Secret Service backend</>, they're stored as item lookup attributes. so like, the backend decides the ✨lore✨, okay?

lowkey a vibe check for your setup: if you switch backends, don't expect the same treatment of SERVICE and USERNAME. that's not me being dramatic, that's just how it is 💅

---

🌈 SEE ALSO 🌈

• secret-tool(1) — another bestie in the password-adjacent friend group 🧚

---

and that's the whole page, bestie!! you just read KEYRING(1) from the General Commands Manual, and it ate. go store some passwords responsibly, stay hydrated, and remember: the footer says KEYRING(1) and so do i 💖✨🎀🦋🌸💅🫶