Skip to main content

pgtui

Terminal user interface for PostgreSQL.

Project status: in development, things will change, but usable.

Install from pypi, preferably using pipx:

pipx install pgtui

Screenshots

Autocomplete:

Data export:

Key bindings

In app, press F1 to see all key bindings.

Default bindings rely a lot on the Alt+key combinations which may not work in all terminals. They seem to not work in gnome terminal, but work in Kitty, Alacritty and Foot.

You can override default key binding by creating a settings file at:

  • ~/.config/pgtui/settings.toml (Linux & co.)
  • %APPDATA%\pgtui\settings.toml (Windows)

Within the settings add a [bindings] section and you can override the key bindings there.

Here's all the bindings at the time of writing:

[bindings]

# General
show_help = "f1"
open_file = "alt+o"
exit = "alt+q"
save = "alt+s"
select_database = "alt+d"

# Editor
execute_query = "alt+enter"
autocomplete_open = "alt+space"
autocomplete_close = "escape"
autocomplete_apply = "tab,enter"
format_query = "alt+f"
format_all = "alt+shift+f"
select_query = "alt+shift+s"
copy_selection = "alt+c"
switch_layout = "alt+x"

# Results
export = "alt+e"
toggle_cursor = "alt+s"

# Tabs
new_tab = "alt+n"
close_tab = "alt+w"
next_tab = "alt+tab,alt+pagedown"
prev_tab = "alt+shift+tab,alt+pageup"
show_tab_1 = "alt+1"
show_tab_2 = "alt+2"
show_tab_3 = "alt+3"
show_tab_4 = "alt+4"
show_tab_5 = "alt+5"
show_tab_6 = "alt+6"
show_tab_7 = "alt+7"
show_tab_8 = "alt+8"
show_tab_9 = "alt+9"
show_tab_10 = "alt+0"

Metadata

Release files for pgtui 0.21.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pgtui 0.21.1
File Size Uploaded
pgtui-0.21.1.tar.gz 36.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pgtui 0.21.1
File Interpreter ABI Platform
pgtui-0.21.1-py3-none-any.whl Python 3 none any Details

Total release size: 66.9 kB

Release files / pgtui-0.21.1.tar.gz

Download URL pgtui-0.21.1.tar.gz
Size 36.9 kB
Tags Source
SHA-256 checksum
How to use checksums
50d4bf50c33e5f60cfe5b7ca57201fabb29212e18f783723e33eba5d034ea3d0
BLAKE2b-256 checksum
How to use checksums
111db6b1f5ac489e56e1c6b3e6c005afeec6bf8d1acd5b02246ef9ae1b74f807
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Release files / pgtui-0.21.1-py3-none-any.whl

Download URL pgtui-0.21.1-py3-none-any.whl
Size 30.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa98a6c604204ffa89171dc0ea777b6255d388baaf63861cad1293bd155ae453
BLAKE2b-256 checksum
How to use checksums
3ef780741e31e5e2f45d76598dce9b9b15d1d25b585c34b4c1c3739b1d9efdf9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.7

Release history Release notifications | RSS feed

This release

0.21.1 This release

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.2

2 release files

0.18.1

2 release files

0.18.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page