pgmoneta-cli(1)

📦
version 0.21.0 · 2 versions
, in nixos 26.05

💅 pgmoneta-cli — the group chat for your backups

okay so bestie, welcome to pgmoneta-cli(1), straight out of the General Commands Manual 💖 this is the little command line bestie that talks to pgmoneta for you, and honestly? she's iconic.

✨ NAME ✨

pgmoneta-cli — the command line utility for pgmoneta 🎀

🌸 SYNOPSIS 🌸

pgmoneta-cli [ -c CONFIG_FILE ] [ COMMAND ]

🦋 DESCRIPTION 🦋

So like, pgmoneta-cli is a command line utility for pgmoneta. that's the whole vibe. she's here, she's queued up in your terminal, and she's ready to do backup things with you 🫶

👑 OPTIONS 👑

these are all the flags, and no cap, you're gonna want to know them:

  • -c, --config CONFIG_FILE — sets the path to the pgmoneta_cli.conf file 💖
  • -h, --host HOST — sets the host name
  • -p, --port PORT — sets the port number
  • -U, --user USERNAME — sets the user name
  • -P, --password PASSWORD — sets the password (shhh 🙈)
  • -L, --logfile FILE — sets the logfile
  • -v, --verbose — outputs a text string of the result, for when you need all the tea
  • -V, --version — displays version information
  • -F, --format text|json|raw — sets the output format. pick your aesthetic ✨
  • -C, --compress none|gz|zstd|lz4|bz2 — compresses the wire protocol. she's squished but she still slays
  • -E, --encrypt none|aes|aes256|aes192|aes128 — encrypts the wire protocol 🔐
  • -s, --sort asc|desc — sorts the result (for list-backup)
  • --cascade — cascades a retain/expunge backup. ripple effect energy 🌊
  • -?, --help — displays help, aka the emotional support flag

💅 COMMANDS 💅

these are the main characters. each one takes the stage:

  • annotate — annotates a backup with comments 💬 like leaving a little sticky note for future you
  • archive — archives a backup from a server
  • backup — backs up a server. the whole point, honestly 👑
  • clear [prometheus] — clears Prometheus data
  • compress — compresses a file using the configured method
  • conf [get|ls|reload|set] — manages the configuration
  • decompress — decompresses a file using the configured method
  • decrypt — decrypts a file using master-key 🔑
  • delete — deletes a backup from a server 💀 gone but not forgotten
  • encrypt — encrypts a file using master-key 🔑
  • expunge — expunges a backup from a server
  • info — gives you information about a backup. the gossip 🍓
  • list-backup — lists the backups for a server
  • mode — switches the mode for a server
  • ping — checks if pgmoneta is alive. hey bestie, u up? 🦋
  • progress — gets progress for a command
  • restore — restores a backup from a server 🌈
  • retain — retains a backup from a server
  • shutdown — shuts down pgmoneta 😭 bye bestie
  • status [details] — status of pgmoneta, with optional details
  • verify — verifies a backup from a server ✅

🐛 REPORTING BUGS 🐛

pgmoneta is maintained on GitHub at <https://github.com/pgmoneta/pgmoneta>

found a bug? don't suffer in silence, bestie — go tell GitHub about it 🫶

pgmoneta is licensed under the 3-clause BSD License.

🧚 SEE ALSO 🧚

pgmoneta-cli.conf(5), pgmoneta.conf(5), pgmoneta(1), pgmoneta-admin(1)

iykyk 👑

and that's the whole page, bestie 💜 this was pgmoneta-cli(1) from the General Commands Manual — go forth, back things up, slay. periodt ✨🎀

📦 where this page comes from