|
1 | | -# 🚀 EC2 TUI |
2 | 1 |
|
3 | | -A blazingly fast Terminal User Interface (TUI) for managing AWS EC2 instances, built with Rust. Seamlessly list your EC2 instances and SSH into them with just a few keystrokes. |
| 2 | +# e2s — EC2 SSH TUI Manager |
| 3 | + |
| 4 | +A **blazingly fast Terminal User Interface (TUI)** for managing AWS EC2 instances, built with **Rust**. |
| 5 | +Browse, filter, and SSH into your EC2 instances **without leaving the terminal**. |
4 | 6 |
|
5 | 7 |  |
| 8 | +<!-- <p align="center"> |
| 9 | + <img src="./.github/assets/info.png" alt="EC2 TUI Demo" style="max-height:600px; width:auto;"> |
| 10 | +</p> --> |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Features |
6 | 15 |
|
| 16 | +* **Interactive EC2 Dashboard** |
| 17 | + Instantly list and navigate all your EC2 instances in a clean, responsive TUI. |
7 | 18 |
|
8 | | -## ✨ Features |
| 19 | +* **One-Keystroke SSH Access** |
| 20 | + SSH into instances using your existing local SSH keys—no copy-pasting needed. |
9 | 21 |
|
10 | | -- 📋 **Interactive Instance List** - View all your EC2 instances in a beautiful TUI |
11 | | -- 🔐 **Quick SSH Access** - Connect to instances using your local SSH keys |
12 | | -- 👤 **Multi-User Support** - Configure multiple SSH users for different distributions |
13 | | -- ⚙️ **Configurable** - Easy TOML-based configuration |
14 | | -- ⚡ **Fast & Lightweight** - Built with Rust for optimal performance |
| 22 | +* **Multi-User SSH Profiles** |
| 23 | + Easily configure multiple SSH users (e.g. `ec2-user`, `ubuntu`, `admin`) for different AMIs. |
| 24 | + |
| 25 | +* **TOML-Based Configuration** |
| 26 | + Simple, readable configuration with sensible defaults. |
| 27 | + |
| 28 | +* **Fast & Lightweight** |
| 29 | + Written in Rust for high performance, low memory usage, and instant startup. |
| 30 | + |
| 31 | +--- |
15 | 32 |
|
16 | | -## 📦 Installation |
17 | | -[Documentation](https://github.com/sandeshgrangdan/e2s/blob/main/USAGES.md) |
| 33 | +## Installation & Usage |
18 | 34 |
|
19 | | -## 🤝 Contributing |
| 35 | +Get **e2s** up and running in minutes and start connecting to your EC2 instances effortlessly. |
20 | 36 |
|
21 | | -Contributions are welcome! Feel free to open issues or submit pull requests on [GitHub](https://github.com/sandeshgrangdan/e2s). |
| 37 | +**Guides** |
| 38 | +- 👉 **[Installation & Usage Guide](https://github.com/sandeshgrangdan/e2s/blob/main/docs/USAGES.md)** |
| 39 | + Learn how to install, run, and use `e2s` effectively. |
| 40 | +- 👉 **[Configuration Guide](https://github.com/sandeshgrangdan/e2s/blob/main/docs/CONFIGURATION.md)** |
| 41 | + Customize SSH users, keys, terminal preferences, and more. |
| 42 | + |
| 43 | +> ⚠️ **Before you start:** |
| 44 | +> Ensure your **AWS credentials** and **SSH keys** are properly configured. |
| 45 | +
|
| 46 | +--- |
| 47 | + |
| 48 | +## How It Works |
| 49 | + |
| 50 | +1. Fetches EC2 metadata using AWS SDK |
| 51 | +2. Displays instances in an interactive TUI |
| 52 | +3. Allows SSH access based on instance metadata and your config |
| 53 | +4. Keeps everything inside your terminal—no browser needed |
| 54 | + |
| 55 | +--- |
22 | 56 |
|
23 | | -## 📝 License |
| 57 | +## Contributing |
24 | 58 |
|
25 | | -This project is open source and available under the MIT License. |
| 59 | +Contributions are **very welcome** |
| 60 | +Whether it’s a bug fix, feature request, or documentation improvement: |
26 | 61 |
|
27 | | -## 🐛 Issues & Support |
| 62 | +* Open an issue |
| 63 | +* Submit a pull request |
| 64 | +* Share ideas and feedback |
28 | 65 |
|
29 | | -If you encounter any issues or have questions, please [open an issue](https://github.com/sandeshgrangdan/e2s/issues) on GitHub. |
| 66 | +👉 [GitHub Repository](https://github.com/sandeshgrangdan/e2s) |
30 | 67 |
|
31 | 68 | --- |
32 | 69 |
|
33 | | -Made with ❤️ and Rust |
| 70 | +## Issues & Support |
| 71 | + |
| 72 | +If you encounter bugs or have questions, please open an issue here: |
| 73 | +👉 [Issues](https://github.com/sandeshgrangdan/e2s/issues) |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## License |
| 78 | + |
| 79 | +This project is licensed under the **MIT License**. |
| 80 | +See the [LICENSE](./LICENSE) file for details. |
| 81 | + |
| 82 | +--- |
| 83 | + |
| 84 | +## Acknowledgements |
| 85 | + |
| 86 | +Built with: |
| 87 | + |
| 88 | +* 🦀 **Rust** |
| 89 | +* 🎨 Terminal UI libraries |
| 90 | +* ☁️ AWS SDK |
| 91 | + |
| 92 | +--- |
| 93 | + |
| 94 | +**Made with ❤️ and Rust by Sandesh** |
| 95 | + |
0 commit comments