Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "e2s"
version = "0.1.3"
version = "0.1.4"
edition = "2021"

# Github Repo
Expand Down
96 changes: 79 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,95 @@
# 🚀 EC2 TUI

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.
# e2s — EC2 SSH TUI Manager

A **blazingly fast Terminal User Interface (TUI)** for managing AWS EC2 instances, built with **Rust**.
Browse, filter, and SSH into your EC2 instances **without leaving the terminal**.

![EC2 TUI Demo](./.github/assets/e2s.png)
<!-- <p align="center">
<img src="./.github/assets/info.png" alt="EC2 TUI Demo" style="max-height:600px; width:auto;">
</p> -->

---

## Features

* **Interactive EC2 Dashboard**
Instantly list and navigate all your EC2 instances in a clean, responsive TUI.

## ✨ Features
* **One-Keystroke SSH Access**
SSH into instances using your existing local SSH keys—no copy-pasting needed.

- 📋 **Interactive Instance List** - View all your EC2 instances in a beautiful TUI
- 🔐 **Quick SSH Access** - Connect to instances using your local SSH keys
- 👤 **Multi-User Support** - Configure multiple SSH users for different distributions
- ⚙️ **Configurable** - Easy TOML-based configuration
- ⚡ **Fast & Lightweight** - Built with Rust for optimal performance
* **Multi-User SSH Profiles**
Easily configure multiple SSH users (e.g. `ec2-user`, `ubuntu`, `admin`) for different AMIs.

* **TOML-Based Configuration**
Simple, readable configuration with sensible defaults.

* **Fast & Lightweight**
Written in Rust for high performance, low memory usage, and instant startup.

---

## 📦 Installation
[Documentation](https://github.com/sandeshgrangdan/e2s/blob/main/USAGES.md)
## Installation & Usage

## 🤝 Contributing
Get **e2s** up and running in minutes and start connecting to your EC2 instances effortlessly.

Contributions are welcome! Feel free to open issues or submit pull requests on [GitHub](https://github.com/sandeshgrangdan/e2s).
**Guides**
- 👉 **[Installation & Usage Guide](https://github.com/sandeshgrangdan/e2s/blob/main/docs/USAGES.md)**
Learn how to install, run, and use `e2s` effectively.
- 👉 **[Configuration Guide](https://github.com/sandeshgrangdan/e2s/blob/main/docs/CONFIGURATION.md)**
Customize SSH users, keys, terminal preferences, and more.

> ⚠️ **Before you start:**
> Ensure your **AWS credentials** and **SSH keys** are properly configured.

---

## How It Works

1. Fetches EC2 metadata using AWS SDK
2. Displays instances in an interactive TUI
3. Allows SSH access based on instance metadata and your config
4. Keeps everything inside your terminal—no browser needed

---

## 📝 License
## Contributing

This project is open source and available under the MIT License.
Contributions are **very welcome**
Whether it’s a bug fix, feature request, or documentation improvement:

## 🐛 Issues & Support
* Open an issue
* Submit a pull request
* Share ideas and feedback

If you encounter any issues or have questions, please [open an issue](https://github.com/sandeshgrangdan/e2s/issues) on GitHub.
👉 [GitHub Repository](https://github.com/sandeshgrangdan/e2s)

---

Made with ❤️ and Rust
## Issues & Support

If you encounter bugs or have questions, please open an issue here:
👉 [Issues](https://github.com/sandeshgrangdan/e2s/issues)

---

## License

This project is licensed under the **MIT License**.
See the [LICENSE](./LICENSE) file for details.

---

## Acknowledgements

Built with:

* 🦀 **Rust**
* 🎨 Terminal UI libraries
* ☁️ AWS SDK

---

**Made with ❤️ and Rust by Sandesh**

97 changes: 0 additions & 97 deletions USAGES.md

This file was deleted.

Loading