Simple Terminal Menu

1.6.6 · active · verified Sun Apr 12

simple-term-menu is a Python package that facilitates the creation of interactive command-line menus. It enables users to select options using arrow keys, j/k (Vim motions), or emacs keys. The library intelligently adapts to terminal capabilities by leveraging the terminfo database, disabling unavailable styles. It is actively maintained, with frequent minor releases, and primarily supports Linux and macOS environments.

Warnings

breaking When upgrading from version 0.x to 1.x, the `TerminalMenu` constructor arguments (except the first parameter for menu entries) became keyword-only. This change was implemented to improve maintainability and allow for easier addition of new parameters.
Fix: Update `TerminalMenu` constructor calls to use keyword arguments for all parameters except the initial list of options.
breaking Between versions 1.1 and 1.2, the `multi_select_key` parameter was renamed to `multi_select_keys` and now expects an iterable of keys. Additionally, `shortcut_parentheses_highlight_style` was renamed to `shortcut_brackets_highlight_style` for consistency.
Fix: Rename `multi_select_key` to `multi_select_keys` and pass an iterable. Rename `shortcut_parentheses_highlight_style` to `shortcut_brackets_highlight_style`.
gotcha simple-term-menu is primarily designed for Unix-like systems (Linux, macOS) and relies on the `terminfo` database. It may not function correctly or provide a consistent experience on Windows due to fundamental differences in terminal capabilities.
Fix: Consider alternative libraries for Windows-specific CLI menus or ensure a compatible terminal environment (e.g., WSL) is used.
gotcha Embedding extensive logic directly within conditional statements for each menu selection can lead to verbose and difficult-to-manage code, especially with many menu options or submenus.
Fix: Refactor menu handling by using classes, dictionaries mapping options to functions, or other structured approaches to keep the code DRY and maintainable.

Install

pip install simple-term-menu Install with pip

Imports

TerminalMenu

from simple_term_menu import TerminalMenu

Quickstart

This quickstart demonstrates how to create a basic terminal menu with a list of options. The `TerminalMenu` class is instantiated with the options, and the `show()` method displays the menu and returns the index of the selected item or `None` if cancelled.

from simple_term_menu import TerminalMenu

def main():
    options = ["entry 1", "entry 2", "entry 3"]
    terminal_menu = TerminalMenu(options)
    menu_entry_index = terminal_menu.show()
    if menu_entry_index is not None:
        print(f"You have selected {options[menu_entry_index]}!")
    else:
        print("Menu cancelled.")

if __name__ == "__main__":
    main()

view raw JSON →