From f575cc49021df01120bf1b7d866582270fff0e89 Mon Sep 17 00:00:00 2001 From: Adem Baccara <71262172+Adembc@users.noreply.github.com> Date: Sat, 30 Aug 2025 15:52:39 +0100 Subject: [PATCH] improve readme file --- README.md | 100 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 66 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index f8551b8..0027f9d 100644 --- a/README.md +++ b/README.md @@ -7,40 +7,12 @@ Lazyssh is a terminal-based, interactive SSH manager inspired by tools like lazydocker and k9s β€” but built for managing your fleet of servers directly from your terminal.
With lazyssh, you can quickly navigate, connect, manage, and transfer files between your local machine and any server defined in your ~/.ssh/config. No more remembering IP addresses or running long scp commands β€” just a clean, keyboard-driven UI. -## πŸŽ₯ Demo - -
-
- App starting splash/loader -
Startup splash / loader
-
-
-
- Server list view -
Scrollable server list with pins and status
-
-
-
- Fuzzy search servers -
Fuzzy search to quickly filter servers
-
-
-
- Add a new server -
Add a new server via the UI form
-
-
-
- SSH connection details -
SSH into the selected server
-
-
- +--- ## ✨ Features -### Server Management (current) +### Server Management - πŸ“œ Read & display servers from your `~/.ssh/config` in a scrollable list. - βž• Add a new server from the UI by specifying alias, host/IP, username, port, identity file. - ✏ Edit existing server entries directly from the UI. @@ -59,10 +31,51 @@ With lazyssh, you can quickly navigate, connect, manage, and transfer files betw - πŸ“ Copy files between local and servers with an easy picker UI. - πŸ“‘ Port forwarding (local↔remote) from the UI. - πŸ”‘ Enhanced Key Management: - - Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub) - - Paste custom public keys manually - - Generate new keypairs and deploy them - - Automatically append keys to ~/.ssh/authorized_keys with correct permissions + - Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub) + - Paste custom public keys manually + - Generate new keypairs and deploy them + - Automatically append keys to ~/.ssh/authorized_keys with correct permissions +--- + +## πŸ“· Screenshots + +
+ +### πŸš€ Startup +App starting splash/loader + +Clean loading screen when launching the app + +--- + +### πŸ“‹ Server Management Dashboard +Server list view + +Main dashboard displaying all configured servers with status indicators, pinned favorites at the top, and easy navigation + +--- + +### πŸ”Ž Search +Fuzzy search servers + +Fuzzy search functionality to quickly find servers by name, IP address, or tags + +--- + +### βž• Add Server +Add a new server + +User-friendly form interface for adding new SSH connections. + +--- + +### πŸ” Connect to server +SSH connection details + +SSH into the selected server + +
+ --- ## πŸ“¦ Installation @@ -126,6 +139,25 @@ Tip: The hint bar at the top of the list shows the most useful shortcuts. --- +## 🀝 Contributing + +Contributions are welcome! + +- If you spot a bug or have a feature request, please [open an issue](https://github.com/adembc/lazyssh/issues). +- If you'd like to contribute, fork the repo and submit a pull request ❀️. + +We love seeing the community make Lazyssh better πŸš€ + +--- + +## ⭐ Support + +If you find Lazyssh useful, please consider giving the repo a **star** ⭐️ and join [stargazers](https://github.com/adembc/lazyssh/stargazers). + +β˜• You can also support me by [buying me a coffee](https://www.buymeacoffee.com/adembc) ❀️ + +--- + ## πŸ™ Acknowledgments - Built with [tview](https://github.com/rivo/tview) and [tcell](https://github.com/gdamore/tcell).