1# Email CLI 🦫
 2
 3---
 4
 5<img src = "assets/logo.png" width=200 height=200>
 6
 7---
 8
 9[![Go CI](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml) [![Go Release](https://github.com/andrinoff/email-cli/actions/workflows/release.yml/badge.svg)](https://github.com/andrinoff/email-cli/actions/workflows/release.yml) [![GitHub issues](https://img.shields.io/github/issues/andrinoff/email-cli)](https://github.com/andrinoff/email-cli/issues)
10
11[![GitHub stars](https://img.shields.io/github/stars/andrinoff/email-cli)](https://github.com/andrinoff/email-cli/stargazers) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/andrinoff/email-cli)](https://github.com/andrinoff/email-cli/releases) [![GoReleaser](https://img.shields.io/badge/GoReleaser-blue?logo=goreleaser)](https://goreleaser.com)
12
13[![Go Version](https://img.shields.io/github/go-mod/go-version/andrinoff/email-cli)](https://golang.org) [![Go Report Card](https://goreportcard.com/badge/github.com/andrinoff/email-cli)](https://goreportcard.com/report/github.com/andrinoff/email-cli) [![Patreon](https://img.shields.io/badge/Patreon-F96854?logo=patreon&logoColor=white)](https://patreon.com/andrinoff)
14
15[![GitHub license](https://img.shields.io/github/license/andrinoff/email-cli)](https://github.com/andrinoff/email-cli/blob/master/LICENSE) [![GitHub contributors](https://img.shields.io/github/contributors/andrinoff/email-cli)](https://github.com/andrinoff/email-cli/graphs/contributors)
16
17A 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!
18
19![Main Menu Screenshot](assets/preview.png)
20
21## Features ✨
22
23- **View Your Inbox**: Fetches and displays a list of your most recent emails.
24- **Read Emails**: Select an email from your inbox to view its content.
25- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
26- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
27- **Secure**: Uses a local configuration file to store your credentials securely.
28- **Supported Providers**: Works with Gmail and iCloud.
29
30## Getting Started 🚀
31
32### Installation via Homebrew 🍺 (MacOS & Linux)
33
34To install Email CLI using Homebrew, run the following commands:
35
36```bash
37brew tap andrinoff/email-cli
38brew install email-cli
39```
40
41After installation, run:
42
43```bash
44email-cli
45```
46
47to get started.
48
49### Install using Snap
50
51```bash
52snap install andrinoff.email-cli
53```
54
55### Build from Source 🔨
56
57Email CLI is written in **Go**. To build it manually:
58
591.  Ensure you have Go installed (`go version`).
602.  Clone the repository:
61
62    ```bash
63    git clone https://github.com/andrinoff/email-cli.git
64    ```
65
663.  Navigate to the project folder:
67
68    ```bash
69    cd email-cli
70    ```
71
724.  Build the binary:
73
74    ```bash
75    go build -o email-cli
76    ```
77
785.  Run it:
79    ```bash
80    ./email-cli
81    ```
82
83## License 📄
84
85This project is distributed under the MIT License. See the `LICENSE` file for more information.
86
87---
88
89Made by [@andrinoff](https://andrinoff.com)