Skip to content

Commit ca4a6e7

Browse files
committed
Add 4.0.0 changes to CHANGELOG with details on readline migration to prompt-toolkit
1 parent 798d400 commit ca4a6e7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
## 4.0.0 (TBD 2026)
2+
3+
### Summary
4+
5+
`cmd2` now has a dependency on
6+
[prompt-toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit) which serves as a
7+
pure-Python cross-platform replacement for
8+
[GNU Readline](https://tiswww.case.edu/php/chet/readline/rltop.html). Previously, `cmd2` had used
9+
different `readline` dependencies on each Operating System (OS) which was at times a very
10+
frustrating developer and user experience due to small inconsistencies in these different readline
11+
libraries. Now we have consistent cross-platform support for tab-completion, user terminal input,
12+
and history. Additionally, this opens up some cool advanced features such as support for syntax
13+
highlighting of user input while typing, auto-suggestions similar to those provided by the fish
14+
shell, and the option for a persistent bottom bar that can display realtime status updates.
15+
16+
### Details
17+
18+
- Breaking Changes
19+
- Removed all use of `readline` built-in module and underlying platform libraries
20+
- Deleted `cmd2.rl_utils` module which dealt with importing the proper `readline` module for
21+
each platform and provided utility functions related to `readline`
22+
- Added a dependency on `prompt-toolkit` and a new `cmd2.pt_utils` module with supporting
23+
utilities
24+
125
## 3.1.0 (December 25, 2025)
226

327
- Potentially Breaking Changes

0 commit comments

Comments
 (0)