1# Email CLI 🦫
 2
 3<div align="center">
 4
 5---
 6
 7<img src = "assets/logo.png" width=200 height=200>
 8
 9---
10
11[![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)
12
13[![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)
14
15[![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)
16
17[![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)
18
19A 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!
20
21![Main Menu Screenshot](assets/preview.png)
22
23</div>
24
25## Features ✨
26
27- **View Your Inbox**: Fetches and displays a list of your most recent emails.
28- **Read Emails**: Select an email from your inbox to view its content.
29- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
30- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
31- **Secure**: Uses a local configuration file to store your credentials securely.
32- **Supported Providers**: Works with Gmail and iCloud.
33
34## Getting Started 🚀
35
36### Installation via Homebrew 🍺 (MacOS & Linux)
37
38To install Email CLI using Homebrew, run the following commands:
39
40```bash
41brew tap andrinoff/email-cli
42brew install email-cli
43```
44
45After installation, run:
46
47```bash
48email-cli
49```
50
51to get started.
52
53### Install using Snap
54
55```bash
56snap install andrinoff.email-cli
57```
58
59### Build from Source 🔨
60
61Email CLI is written in **Go**. To build it manually:
62
631.  Ensure you have Go installed (`go version`).
642.  Clone the repository:
65
66    ```bash
67    git clone https://github.com/andrinoff/email-cli.git
68    ```
69
703.  Navigate to the project folder:
71
72    ```bash
73    cd email-cli
74    ```
75
764.  Build the binary:
77
78    ```bash
79    go build -o email-cli
80    ```
81
825.  Run it:
83    ```bash
84    ./email-cli
85    ```
86
87## License 📄
88
89This project is distributed under the MIT License. See the `LICENSE` file for more information.
90
91---
92
93Made by [@andrinoff](https://andrinoff.com)