A terminal user interface for Gmail, built with Python and Textual.
- Modern terminal user interface
- Keyboard-driven interface
This project is not yet available on PyPI. You can install it directly from GitHub:
# Install with pip from GitHub
pip install git+https://github.com/black-desk/gmail-tui.git
# Install with Poetry from GitHub
poetry add git+https://github.com/black-desk/gmail-tui.git
# Or clone the repository and install locally
git clone https://github.com/black-desk/gmail-tui.git
cd gmail-tui
poetry installGmail TUI provides a command-line interface with several subcommands:
# Launch the TUI application
gmail-tui
# Initialize configuration (first-time setup)
gmail-tui init
# List emails in a folder
gmail-tui ls
# Display email folders in tree format
gmail-tui treeinit: Initialize Gmail TUI configurationls: List emails in a folder (outputs metadata in various formats)tree: Display email folders in tree format
For more details on each command, use the --help option:
gmail-tui --help
gmail-tui <command> --helpIf you're interested in contributing to Gmail TUI, please check the Contributing Guidelines for instructions on development, code style, and licensing requirements.
This project is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later). The project follows the REUSE Specification for license and copyright information. For details on license compliance, please see the Contributing Guidelines.