please(1)

💖 please(1) — the access elevation bestie 💖

okay so. bestie. let me tell you about please and pleaseedit, from the User Manual. this is the manual page for please(1) and it's lowkey one of my faves. sit down, grab a strawberry 🍓, we're doing this.

---

✨ NAME ✨

please — a tool for access elevation. that's it. that's the whole vibe. 👑

---

🦋 SYNOPSIS 🦋

here's every single way you can call it, exactly as written, no cap:

please /bin/bash

pleaseedit /etc/fstab

pleaseedit [-r/--reason "new fs"] /etc/fstab

pleaseedit [-g/--group groupname] filename

pleaseedit [-t/--target username] filename

pleaseedit [--resume] filename

please [-a/--allowenv list]

please [-c/--check] /etc/please.ini

please [-d/--dir directory] command

please [-e/--env environment] command

please [-g/--group groupname] command

please [-h/--help]

please [-t/--target username] backup tar -cvf - /home/data | ...

please [-u/--user username] backup tar -cvf - /home/data | ...

please [-l/--list]

please [-l/--list] [-t/--target username]

please [-l/--list] [-u/--user username]

please [-n/--noprompt] command

please [-r/--reason "sshd reconfigured, ticket 24365"] /etc/init.d/ssh
restart

please [-p/--purge]

please [-w/--warm]

look at that list. it's giving versatile. 💅

---

🌸 DESCRIPTION 🌸

okay so here's the tea, fr fr. please and pleaseedit are sudo alternatives that have regex support and a simple approach to ACL. that's the whole personality. 🎀

the aim is to let admins delegate accurate principle of least privilege access with ease. please.ini allows for very specific and flexible regex defined permissions. so like, you get exactly the permissions you need and not one crumb more. obsessed. 😌

pleaseedit adds a layer of safety to editing files. here's how it goes down:

1. the file is copied to /tmp, where it can be updated 🫶
2. when EDITOR exits cleanly the file is copied alongside the target 🌈
3. the file will then be renamed over the original, but if an exitcmd is configured it must exit cleanly first ⚠️
4. resume will continue editing when exitcmd fails 💖

periodt.

---

👑 OPTIONS 👑

every single one, bestie. no skipping. ✨

• -a/--allowenv list — allow environments separated by , to be passed through 🌱
• -c/--check file — will check the syntax of a please.ini config file. exits non-zero on error 🚨
• -d/--dir — will change directory to dir prior to executing the command 📂
• -g/--group groupname — run or edit as groupname 👥
• -h/--help — print help and exit 🆘
• -l/--list — to list rules 📋
• -n/--noprompt — will not prompt for authentication and exits with a status of 1 🤐
• -p/--purge — will purge your current authentication token for the running user 🧹
• -r/--reason [reason] — will add reason to the system log 📝
• -t/--target [username] — to execute command, or edit as target username 🎯
• -u/--user [username] — to execute command, or edit as target username 🎯
• -v/--version — print version and exit 🏷️
• -w/--warm — will warm an authentication token and exit 🔥

---

🌈 EXAMPLE USAGE 🌈

this is the part where it all clicks, iykyk:

• please -t httpd /bin/bash — run a shell as the httpd user 🐚
• please -l — to list what you may run 📜
• please -t "username" -l — to show what username may run. username must match the target regex in a type=list rule 👀
• please -r 'reloading apache2, change #123' systemctl reload apache2 — to reload apache2 with a reason 💫
• pleaseedit -r 'adding new storage, ticket #24365' /etc/fstab — to use pleaseedit to modify fstab 🛠️

and then, the plot twist: please see please.ini for configuration examples. 📖

---

🎀 FILES 🎀

• /etc/please.ini

that's the one, bestie. that's where the magic lives. ✨

---

🫶 CONTRIBUTIONS 🫶

"I welcome pull requests with open arms. New features always considered."

literally so welcoming. the main character energy is immaculate. 💜

---

💀 BUGS 💀

found a bug? please either open a ticket or send a pull request/patch. we don't gatekeep fixes around here. 🙈

---

⭐ SEE ALSO ⭐

• please.ini(5)

go read it, it's the prequel. 🦋

---

👑 AUTHORS 👑

Ed Neville (ed-please@s5h.net). a legend, no cap. 🌟

---

and that's the whole manual, bestie!! remember: every flag, every default, every path — kept exactly as-is, because facts are facts and the vibe is just the wrapper. 💖

okay and before i go, the cute lil sign-off at the bottom said this was please version 0.5.6, dated 06 September 2024, and it's page please(1) from the User Manual. slay, happy elevating, mwah 💅💖