Skip to content

Add cursor shape indicator for vi mode #1558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joryeugene wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −0
Open

Add cursor shape indicator for vi mode #1558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
678f1e7
feat: enable modal cursor shape in vi mode
joryeugene Feb 25, 2026
a74df47
Add cursor shape indicator to vi mode changelog
joryeugene Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Upcoming (TBD)
Features:
---------
* Add support for `\\T` prompt escape sequence to display transaction status (similar to psql's `%x`).
* Add cursor shape support for vi mode. When ``vi = True``, the terminal cursor now
reflects the current editing mode: beam in INSERT, block in NORMAL, underline in REPLACE.
Uses prompt_toolkit's ``ModalCursorShapeConfig``.

4.4.0 (2025-12-24)
==================
Expand Down
2 changes: 2 additions & 0 deletions pgcli/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
)
from prompt_toolkit.history import FileHistory
from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
from prompt_toolkit.cursor_shapes import ModalCursorShapeConfig
from pygments.lexers.sql import PostgresLexer

from pgspecial.main import PGSpecial, NO_QUERY, PAGER_OFF, PAGER_LONG_OUTPUT
Expand Down Expand Up @@ -1087,6 +1088,7 @@ def get_continuation(width, line_number, is_soft_wrap):
enable_suspend=True,
editing_mode=EditingMode.VI if self.vi_mode else EditingMode.EMACS,
search_ignore_case=True,
cursor=ModalCursorShapeConfig(),
)

return prompt_app
Expand Down