Skip to content

docs: add missing options to the README help output - #1660

Open
Aryapatel-007 wants to merge 1 commit into
dbcli:mainfrom
Aryapatel-007:docs/readme-help-options
Open

Aryapatel-007 wants to merge 1 commit into
dbcli:mainfrom
Aryapatel-007:docs/readme-help-options

Conversation

@Aryapatel-007

@Aryapatel-007 Aryapatel-007 commented Nov 6, 2026 •

Copy link
Copy Markdown

Description

The pgcli --help output in the README is missing options that pgcli/main.py defines: --timeout, --application-name, -t/--tuples-only, --ping, --ssh-tunnel, --log-file, --init-command, -c/--command, -y/--yes and -f/--file. It also shows --warn [all|moderate|off], but the option now has no Choice type, so it's --warn TEXT.

Please check the formatting: I couldn't run pgcli --help in my environment. I built this block from the @click.option definitions, in their order, following Click's layout, so the spacing or wrapping may differ slightly from the real output. Replacing it with real output would be fine.

AI disclosure: this PR was generated by Claude Code (Claude Opus 5.5).

Update: when I opened this PR I hadn't run pgcli --help, as the note above says, and that check shouldn't have been left to you. I've since installed this branch and run it, and the README block matches the real output exactly at 80 columns. tests/test_main.py gave 93 passed and 23 skipped (those need a local Postgres server), and README.rst parses with docutils. I haven't tested against a live database.

Checklist

  • I've added this contribution to the changelog.rst.
  • I've added my name to the AUTHORS file (or it's already there).
  • I installed pre-commit hooks (pip install pre-commit && pre-commit install).
  • I verified that my changes work as expected (this may include manually testing them in your local environment). See the update above.
  • Please squash merge this pull request (uncheck if you'd like us to merge as multiple commits)

@dbaty

dbaty commented Nov 6, 2026 •

Copy link
Copy Markdown
Member

Please check the formatting: I couldn't run pgcli --help in my environment

Why is that? And if you have merely guessed what the output looks like, then aren't you putting the burden of checking on the maintainers' shoulders? I mean, we maintainers would probably have checked, but here we're not just checking: we're doing the work. So why submit a pull request? Just submit an issue, then.

Please do not submit pull requests if you do not or cannot use pgcli.

@Aryapatel-007

Copy link
Copy Markdown
Author

You're right, and I'm sorry. I used an AI tool for this PR, and it couldn't run pgcli when it prepared it, so that check got left to you. That shouldn't have happened.
I've now installed this branch and run it. The block in the README matches the real pgcli --help output exactly at 80 columns. This PR only touches docs, so no code changed. In tests/test_main.py, 93 tests passed and 23 were skipped because they need a local Postgres server, which I don't have here.
If you'd rather not take an AI-assisted PR, I understand and will close it.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants