1# Email CLI 📧
2
3[](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml) [](https://github.com/andrinoff/email-cli/actions/workflows/release.yml) [](https://github.com/andrinoff/email-cli/issues) [](https://github.com/andrinoff/email-cli/stargazers)
4
5A 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!
6
7
8
9## Features ✨
10
11- **View Your Inbox**: Fetches and displays a list of your most recent emails.
12- **Read Emails**: Select an email from your inbox to view its content.
13- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
14- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
15- **Secure**: Uses a local configuration file to store your credentials securely.
16- **Supported Providers**: Works with Gmail and iCloud.
17
18## Getting Started 🚀
19
20### Installation via Homebrew 🍺 (MacOS & Linux)
21
22To install Email CLI using Homebrew, run the following commands:
23
24```bash
25brew tap andrinoff/email-cli
26brew install email-cli
27```
28
29After installation, run:
30
31```bash
32email-cli
33```
34
35to get started.
36
37### Install using Snap
38
39```bash
40snap install andrinoff.email-cli
41```
42
43### Build from Source 🔨
44
45Email CLI is written in **Go**. To build it manually:
46
471. Ensure you have Go installed (`go version`).
482. Clone the repository:
49
50 ```bash
51 git clone https://github.com/andrinoff/email-cli.git
52 ```
53
543. Navigate to the project folder:
55
56 ```bash
57 cd email-cli
58 ```
59
604. Build the binary:
61
62 ```bash
63 go build -o email-cli
64 ```
65
665. Run it:
67 ```bash
68 ./email-cli
69 ```
70
71## License 📄
72
73This project is distributed under the MIT License. See the `LICENSE` file for more information.
74
75---
76
77Made by [@andrinoff](https://andrinoff.com)