1# Email CLI 📧
2
3[](https://github.com/andrinoff/email-cli/actions/workflows/ci.yml)
4[](https://github.com/andrinoff/email-cli/issues)
5
6
7A 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!
8
9
10
11## Features ✨
12
13- **View Your Inbox**: Fetches and displays a list of your most recent emails.
14- **Read Emails**: Select an email from your inbox to view its content.
15- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
16- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
17- **Secure**: Uses a local configuration file to store your credentials securely.
18
19## Getting Started 🚀
20
21Follow these instructions to get the email client up and running on your local machine.
22
23### Prerequisites
24
25- **Go**: You need to have Go (version 1.18 or newer) installed on your system. You can download it from the [official Go website](https://golang.org/dl/).
26
27### Installation & Setup
28
291. **Clone the repository:**
30
31 ```bash
32 git clone [https://github.com/andrinoff/email-cli.git](https://github.com/andrinoff/email-cli.git)
33 cd email-cli
34 ```
35
362. Login
37
38 You will have 4 input fields
39
40 1. Provider (currently, `gmail` or `icloud`)
41 2. Email
42 3. App-specific Password (TODO: add a guide)
43 4. Name to sign off (OPTIONAL, but recommended)
44
453. **Run the application:**
46 Once your `config.json` file is set up, you can run the application directly from your terminal:
47 ```bash
48 go run .
49 ```
50
51## Usage ⌨️
52
53The Email CLI is designed to be intuitive and easy to navigate with your keyboard.
54
55- **Main Menu**: Use the `Up`/`Down` arrow keys or `k`/`j` to navigate the main menu choices. Press `Enter` to select an option.
56- **Inbox View**: In the inbox, use the arrow keys to scroll through your emails. Press `Enter` to open and view a selected email.
57- **Composer**:
58 - Use `Tab` or the arrow keys to move between the "To", "Subject", and "Body" fields.
59 - When you are finished composing your email, navigate to the "Body" field and press `Enter` to send it.
60- **Go Back/Quit**:
61 - Press `Esc` from any view to return to the main menu.
62 - Press `Ctrl+C` at any time to quit the application.
63
64## Built With 🛠️
65
66This project is built with some fantastic Go libraries:
67
68- [Bubble Tea](https://github.com/charmbracelet/bubbletea) - A powerful TUI (Text User Interface) framework.
69- [Lipgloss](https://github.com/charmbracelet/lipgloss) - A library for beautiful, style-driven layouts in the terminal.
70- [Bubbles](https://github.com/charmbracelet/bubbles) - A collection of ready-to-use components for Bubble Tea applications.
71
72## License 📄
73
74This project is distributed under the MIT License. See the `LICENSE` file for more information.
75
76---
77
78Made with ❤️ by [@andrinoff](https://andrinoff.com)