--- ``` __ __ ____ ___ ____ _/ /______/ /_ ____ _ / __ '__ \/ __ '/ __/ ___/ __ \/ __ '/ / / / / / / /_/ / /_/ /__/ / / / /_/ / /_/ /_/ /_/\__,_/\__/\___/_/ /_/\__,_/ ``` --- [![Go CI](https://github.com/floatpane/matcha/actions/workflows/ci.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/ci.yml) [![Go Release](https://github.com/floatpane/matcha/actions/workflows/release.yml/badge.svg)](https://github.com/floatpane/matcha/actions/workflows/release.yml) [![Go Version](https://img.shields.io/github/go-mod/go-version/floatpane/matcha)](https://golang.org) [![Go Report Card](https://goreportcard.com/badge/github.com/floatpane/matcha)](https://goreportcard.com/report/github.com/floatpane/matcha) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/floatpane/matcha)](https://github.com/floatpane/matcha/releases) [![GitHub All Releases](https://img.shields.io/github/downloads/floatpane/matcha/total)](https://github.com/floatpane/matcha/releases) [![GitHub license](https://img.shields.io/github/license/floatpane/matcha)](https://github.com/floatpane/matcha/blob/master/LICENSE) **A powerful, feature-rich email client for your terminal.** Built with Go and the Bubble Tea TUI framework, Matcha brings a beautiful, modern email experience to the command line with support for rich content, multiple accounts, and advanced terminal features.
![Demo GIF](public/assets/demo.gif) ## Documentation - **[Installation Guide](docs/INSTALLATION.md)**: Steps to get Matcha running on your system. - **[Configuration](docs/CONFIGURATION.md)**: Detailed configuration options and file locations. - **[Usage & Keybindings](docs/USAGE.md)**: How to use Matcha, including keyboard shortcuts. ## Features Explore the detailed documentation for Matcha's features: - **[Email Management](docs/features/EMAIL_MANAGEMENT.md)**: Inbox, sent mail, search, and rich viewing. - **[Image Compatibility](docs/features/images/COMPATABILITY.md)**: Support for modern terminal image protocols. - **[Composing Emails](docs/features/COMPOSING.md)**: Writing, attachments, and markdown support. - **[Draft Management](docs/features/DRAFTS.md)**: saving and resuming drafts. - **[Account Management](docs/features/ACCOUNTS.md)**: Managing multiple accounts and providers. - **[Contact Management](docs/features/CONTACTS.md)**: Address book and auto-saving. - **[User Interface](docs/features/UI.md)**: TUI design and customization. - **[Advanced Features](docs/features/ADVANCED.md)**: Updates, caching, and debugging. ## Contributing Contributions are welcome! Please feel free to submit a Pull Request. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. ## License This project is distributed under the MIT License. See the `LICENSE` file for more information. ---
**[Report Bug](https://github.com/floatpane/matcha/issues/new?template=bug_report.md)** · **[Request Feature](https://github.com/floatpane/matcha/issues/new?template=feature_request.md)** · **[Contributing Guidelines](https://github.com/floatpane/matcha/blob/master/CONTRIBUTING.md)**