PGEXPORTER-ADMIN(1)

📦 version 0.7.0, in alpine 3.24

🎀 PGEXPORTER-ADMIN 🎀

okay so bestie, welcome to the manual page for pgexporter-admin, which lives in section 1 (General Commands Manual, iykyk — the one for actual runnable commands). If you've ever been like "how do I even administer pgexporter," this is literally the page for you. Buckle in 💅

✨ NAME ✨

pgexporter-admin — the administration utility for pgexporter. that's it, that's the whole vibe. it's the little tool that handles the admin side of pgexporter and honestly it ate.

🌸 SYNOPSIS 🌸

pgexporter-admin [ -f FILE ] [ COMMAND ]

that's the whole shape of it — a couple of optional flags, then a command if you want one 🦋

💖 DESCRIPTION 💖

pgexporter-admin is an administration utility for pgexporter. no cap, that's the description, it's short but it's iconic. it's the tool you reach for when you need to do admin things with pgexporter.

💅 OPTIONS 💅

every single one of these, no skips:

  • -f, --file FILE — set the path to a user file. yes, the flag is -f, the long form is --file, and it takes a FILE. 🎀
  • -U, --user USER — set the user name. -U for short, --user if you're feeling verbose.
  • -P, --password PASSWORD — set the password for the user. (and sidenote, this one has opinions about precedence — more on that in the environment variables section 👀)
  • -g, --generate — generate a password. lowkey the most useful one here ngl, let the tool cook 🔥
  • -l, --length — password length. it's -l, it's --length, and it controls how long the generated password is. mid-flag-name but okay we love her
  • -V, --version — display version information. main character energy of "which build am I even on"
  • -?, --help — display help. yes, the short flag is literally -? and that's iconic of it 🫶

👑 COMMANDS 👑

these are the actual actions, bestie:

  • master-key — create or update the master key. the master key gets created in the pgexporter user home directory, under ~/.pgexporter. put some respect on that path ✨
  • user add — add a user. simple, clean, slay.
  • user edit — edit a user. glow-up time.
  • user user del — delete a user. and yes, it really is written user user del in the manual — that extra user is not me being chaotic, that's just how it's printed here. copy it exactly if you're scripting it, don't @ me 💀
  • user ls — list all users. so you can see everyone in the group chat 🌈

🧚 ENVIRONMENT VARIABLES 🧚

  • PGEXPORTER_PASSWORD — okay this one's doing double duty, so pay attention bestie. provide either a key for use with the master-key command, or a user password for use with the user add or user edit commands. if it's provided, pgexporter-admin will not ask for the key/password interactively — it just takes it. and here's the important part, no cap: a password provided using the --password command line argument will have precedence over this variable. so CLI beats env var. periodt.
⚠️ real talk on that precedence thing — if you're setting both and expecting the variable to win, it will not, --password wins. don't get caught out 🙈

💀 REPORTING BUGS 💀

found a bug? first of all, sorry bestie. second of all, pgexporter is maintained on GitHub at <https://github.com/pgexporter/pgexporter> — that's where you go to report it. the maintainers are there, go tell them 🫶

pgexporter is licensed under the 3-clause BSD License. legal stuff but make it cute, we love an open-source queen 👑

⭐ SEE ALSO ⭐

go read these too, they're the friend group:

and that's the page!! 💖 this whole thing comes to you from the General Commands Manual (section 1, where all the runnable commands hang out), and at the very bottom of the page the footer is just PGEXPORTER-ADMIN(1) all over again with the source/version-and-date info sitting there quietly — which is honestly giving "signing off with the same energy we came in with." bye bestie, go administer something 🎀🦋✨

📦 where this page comes from