EYAML(1)

✨ EYAML — the moment has arrived 💅

okay bestie, so eyaml is the command line interface for the hiera eyaml backend — it lives in section 1 of the manual (general commands, the cool section, obviously). Think of it as your group chat with secrets: it makes keys, locks stuff up, unlocks stuff, and also babysits your text editor while you do it. 🎀

---

🦋 SYNOPSIS

eyaml [--help] [subcommand [subcommand options]]

🌸 all subcommands

like, EVERY subcommand gets these. they're the universal besties:

• --help, -h — display help. your "wait what does this do again" button 🫶
• --version — display program version. so you know what you're working with ✨
• --verbose, -v — be more verbose. it will NOT stop talking, and honestly? we love that 💬
• --quiet, -q — be less verbose. the introvert setting 🤫
• --encrypt-method, -n METHOD — override default encryption and decryption method (default: pkcs7). don't change it unless you know, iykyk 👑
• --pkcs7-private-key -FILE — path to private key (default: ./keys/private_key.pkcs7.pem). that's YOUR secret, guard it with your life 🔐
• --pkcs7-public-key -FILE — path to public key (default: ./keys/public_key.pkcs7.pem). this one's the shareable one 💖
• --pkcs7-subject -SUBJECT — subject to use for certificate when creating keys (default: /) 📜

🧚 subcommands, one by one

• eyaml createkeys [options] — create a new key pair. baby's first keys, iconic behavior 🔑
• eyaml decrypt [options] — decrypt data. the un-scrambling ✨
  • --string STRING — source input STRING is provided as an argument
  • --file, -f FILE — source input FILE is a regular file
  • --eyaml, -e FILE — source input FILE is an eyaml file
  • --stdin — source input is taken from STDIN
• eyaml edit FILE — edit a file. yes it literally opens your editor for you, main character energy 🎬
• eyaml encrypt [options] — the scrambling 🔥
  • --password, -p — source input is a password entered on the terminal
  • --eyaml, -e FILE — source input FILE is an eyaml file
  • --file, -f FILE — source input FILE is a regular file
  • --stdin — source input is taken from STDIN
  • --string STRING — source input STRING is provided as an argument
  • --output, -o — output format of final result (examples, block, string) (default: examples)
  • --label, -l LABEL — apply a label to the encrypted result
• eyaml recrypt [options] — recrypt an eyaml file. re-doing the thing, but make it fresh ♻️
• eyaml version — show version information 📌

---

💜 DESCRIPTION

The eyaml command is a command line interface for hiera-eyaml. It is used to create keys, encrypt and decrypt data, and act as a wrapper around a text editor. That's it, that's the whole vibe: keys, secrets, editor vibes. No cap. 🌈

---

🍓 EXAMPLES

🔒 encrypting data

$ eyaml encrypt --string 'foo bar'

Encrypts the command line argument to --string, and outputs the encrypted data on two formats, line and block. This can be included in an .eyaml file. The eyaml command expects keys to be present in the ./keys/ directory by default. So like... put your keys there or it's gonna be awkward 😭

✏️ using the editor wrapper

$ eyaml edit hieradata/common.eyaml

Decrypts the file into a temporary file, and opens the file in a text editor. Values to be encrypted are wrapped in markup. When the file is saved, any changed values are encrypted. You literally just type and save and it handles the cryptography for you. slay. 💅

---

👑 AUTHORS

eyaml was written by Geoff Meakin, Peter Dyson, Robert Fielding, Simon Hildrew and Tom Poulton. legends, all of them, we stan 🫶

This man page was written by Stig Sandbeck Mathisen for the Debian distribution, but may be used by others. sharing is caring bestie 💖

---

💀 BUGS

The file referenced in eyaml edit must exist. Like, it has to be THERE. no file, no edit. 🙈

An error in the markup may result in eyaml edit not being able to open the file. so double-check your markup before you come for the editor, fr fr ⚠️

---

and that's the whole page, bestie — brought to you by the <b>Debian</b> crew, dated <b>Mar 31, 2014</b>, and honestly? still eating. go encrypt something. 💖✨