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
44
45## Features ✨
46
47- **View Your Inbox**: Fetches and displays a list of your most recent emails.
48- **Read Emails**: Select an email from your inbox to view its content.
49- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
50- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
51- **Secure**: Uses a local configuration file to store your credentials securely.
52- **Supported Providers**: Works with Gmail and iCloud.
53
54## Installation 🚀
55
56There are several ways to install Matcha.
57
58### Package Managers
59
60#### Homebrew 🍺 (macOS & Linux)
61
62```bash
63brew tap floatpane/matcha
64brew install matcha
65```
66
67After installation, run:
68
69```bash
70matcha
71```
72
73to get started.
74
75### Install using Snap
76
77```bash
78sudo snap install matcha
79```
80
81### Build from Source 🔨
82
83Matcha is written in **Go**. To build it manually:
84
851. Ensure you have Go installed (`go version`).
862. Clone the repository:
87
88 ```bash
89 git clone https://github.com/floatpane/matcha.git
90 ```
91
923. Navigate to the project folder:
93
94 ```bash
95 cd matcha
96 ```
97
984. Build the binary:
99
100 ```bash
101 go build -o matcha
102 ```
103
1045. Run it:
105 ```bash
106 ./matcha
107 ```
108
109## License 📄
110
111This project is distributed under the MIT License. See the `LICENSE` file for more information.