1<div align="center">
2
3---
4
5<img src = "assets/logo.png" width=200 height=200>
6
7```
8 __ __
9 ____ ___ ____ _/ /______/ /_ ____ _
10 / __ '__ \/ __ '/ __/ ___/ __ \/ __ '/
11 / / / / / / /_/ / /_/ /__/ / / / /_/ /
12/_/ /_/ /_/\__,_/\__/\___/_/ /_/\__,_/
13```
14
15---
16
17[](https://github.com/floatpane/matcha/actions/workflows/ci.yml)
18[](https://github.com/floatpane/matcha/actions/workflows/release.yml)
19[](https://goreleaser.com)
20[](https://golang.org)
21[](https://goreportcard.com/report/github.com/floatpane/matcha)
22
23[](https://github.com/floatpane/matcha/releases)
24[](https://github.com/floatpane/matcha/releases)
25[](https://github.com/floatpane/matcha/stargazers)
26[](https://github.com/floatpane/matcha/issues)
27[](https://github.com/floatpane/matcha/blob/master/LICENSE)
28
29[](https://www.apple.com/macos)
30[](https://www.linux.org/)
31[](https://brew.sh)
32[](https://snapcraft.io/matcha)
33
34[](https://patreon.com/andrinoff)
35[](https://github.com/floatpane/matcha/graphs/contributors)
36[](https://github.com/charmbracelet/bubbletea)
37
38A beautiful and functional email client for your terminal, built with Go and the charming Bubble Tea TUI library. Never leave your command line to check your inbox or send an email again!
39
40
41</div>
42
43## Features ✨
44
45- **View Your Inbox**: Fetches and displays a list of your most recent emails.
46- **Read Emails**: Select an email from your inbox to view its content.
47- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
48- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
49- **Secure**: Uses a local configuration file to store your credentials securely.
50- **Supported Providers**: Works with Gmail and iCloud.
51
52## Installation 🚀
53
54There are several ways to install Matcha.
55
56### Package Managers
57
58#### Homebrew 🍺 (macOS & Linux)
59
60```bash
61brew tap floatpane/matcha
62brew install matcha
63```
64
65After installation, run:
66
67```bash
68matcha
69```
70
71to get started.
72
73### Install using Snap
74
75```bash
76sudo snap install matcha
77```
78
79### Build from Source 🔨
80
81Matcha is written in **Go**. To build it manually:
82
831. Ensure you have Go installed (`go version`).
842. Clone the repository:
85
86 ```bash
87 git clone https://github.com/floatpane/matcha.git
88 ```
89
903. Navigate to the project folder:
91
92 ```bash
93 cd matcha
94 ```
95
964. Build the binary:
97
98 ```bash
99 go build -o matcha
100 ```
101
1025. Run it:
103 ```bash
104 ./matcha
105 ```
106
107## License 📄
108
109This project is distributed under the MIT License. See the `LICENSE` file for more information.