PGCLI(1)

📦
version 4.7.1 · 4 versions
, in fedora 43, fedora 44

💅 PGCLI — like, the manual, but make it make sense

okay bestie, sit down, hydrate, because we're talking about pgcli — the Postgres client that actually gets you. ✨ This is the manual page for pgcli version 4.7.1, and I'm gonna walk you through every single flag like we're texting at 2am. No skips. No "you'll figure it out." We're doing this properly. 🫶

✨ NAME ✨

pgcli — the manual page for pgcli 4.7.1. That's it, that's the name, iconic behavior honestly. 💅

🌸 SYNOPSIS 🌸

pgcli [OPTIONS] [DBNAME] [USERNAME]

so you got your OPTIONS, you got an optional DBNAME, you got an optional USERNAME — and you're off to the races, babe. 🌈

👑 OPTIONS 👑

Every single one, in order, no cap. Read them all, they're literally all useful.

  • -h, --host TEXT — the host address of the postgres database. where is she? tell me where she lives. 🏠
  • -p, --port INTEGER — the port number at which the postgres instance is listening. it's giving "I'm on this port and I'm not moving." 🎀
  • -U, --username TEXT — the username to connect to the postgres database.
  • -u, --user TEXT — the username to connect to the postgres database. yes bestie, it's the same thing as -U, two spellings, one vibe. 💜
  • --timeout INTEGER — how many seconds to wait for a connection before giving up. and listen: 0 waits forever, which is a choice. This one overrides both the connection string and $PGCONNECT_TIMEOUT. she said "I don't care what they told you, I'm in charge." 😤
  • -W, --password — force the password prompt. you will be asked. no escape. 🔐
  • -w, --no-password — never prompt for a password. the opposite energy. also no escape, just in the other direction. 💀
  • --single-connection — do not use a separate connection for completions. one connection, one queen, no side pieces. 👑
  • -v, --version — the version of pgcli. show me your ID. 🪪
  • -d, --dbname TEXT — the database name to connect to. which one are we pulling up. 🍓
  • --pgclirc FILE — the location of the pgclirc file. your config, your rules. ✨
  • -D, --dsn TEXT — use a DSN configured in the [alias_dsn] section of the pgclirc file. cute little nickname for your connection. 🦋
  • --list-dsn — shows the list of DSNs configured in the [alias_dsn] section of the pgclirc file. a little roster. 📋
  • --row-limit INTEGER — set the threshold for the row limit prompt. use 0 to disable the prompt entirely. (yes, zero = off, noted, don't forget.) 🙈
  • --application-name TEXT — the application name for the connection.
  • --less-chatty — skip the intro on startup and the goodbye on exit. for when you're in your mysterious, no-small-talk era. 🎧
  • -t, --tuples-only — print rows only: no column headers, no status footer, and no timing, just like psql. strictly business. 🔥
  • --prompt TEXT — the prompt format. Default: "\u@\h:\d> ".
  • --prompt-dsn TEXT — the prompt format for connections using DSN aliases. Default: "\u@\h:\d> ". (same default, different situation, she's flexible.) 🌟
  • -l, --list — list the available databases, then exit. window shopping, basically. 🛍️
  • --ping — check database connectivity, then exit. u up? 📶
  • --auto-vertical-output — automatically switch to vertical output mode if the result is wider than the terminal width. she adapts. 💅
  • --warn TEXT — warn before running a destructive query. a little "bestie are you SURE" moment. ⚠️
  • --ssh-tunnel TEXT — open an SSH tunnel to the given address and connect to the database from it. sneaky, secure, slay. 🚇
  • --log-file TEXT — write all queries & output into a file, in addition to the normal output destination. receipts, always. 🧾
  • --init-command TEXT — an SQL statement to execute after connecting. a lil opening act. 🎬
  • -c, --command TEXT — run a command (SQL or internal) and exit. multiple -c options are allowed, so stack 'em up, queen. 🥞
  • -y, --yes — force destructive commands without the confirmation prompt. bold. fearless. possibly chaotic. you've been warned. 😭
  • -f, --file FILE — execute commands from a file, then exit. multiple -f options are allowed, yes you can pile those on too. 📂
  • --help — show this message and exit. hi, hello, welcome, here's everything, bye. 👋
💖 reminder: every flag above does exactly what it says and nothing more. I'm not out here inventing behavior for you, bestie. that's the whole point.

🎀 a lil sign-off 🎀

this page is from pgcli 4.7.1, dated September 2026. mwah. go connect to something. 💜✨🦋

📦 where this page comes from