Skip to content

Commit 75b0170

Browse files
authored
improve docs (#4)
1 parent e2f38b1 commit 75b0170

File tree

7 files changed

+62
-27
lines changed

7 files changed

+62
-27
lines changed

README.md

Lines changed: 61 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77
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.
88
<br/>
99
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.
10-
## 🎥 Demo
11-
1210

11+
---
1312

1413
## ✨ Features
1514

16-
### Server Management (current)
15+
### Server Management
1716
- 📜 Read & display servers from your `~/.ssh/config` in a scrollable list.
1817
- ➕ Add a new server from the UI by specifying alias, host/IP, username, port, identity file.
1918
- ✏ Edit existing server entries directly from the UI.
@@ -32,10 +31,51 @@ With lazyssh, you can quickly navigate, connect, manage, and transfer files betw
3231
- 📁 Copy files between local and servers with an easy picker UI.
3332
- 📡 Port forwarding (local↔remote) from the UI.
3433
- 🔑 Enhanced Key Management:
35-
- Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub)
36-
- Paste custom public keys manually
37-
- Generate new keypairs and deploy them
38-
- Automatically append keys to ~/.ssh/authorized_keys with correct permissions
34+
- Use default local public key (~/.ssh/id_ed25519.pub or ~/.ssh/id_rsa.pub)
35+
- Paste custom public keys manually
36+
- Generate new keypairs and deploy them
37+
- Automatically append keys to ~/.ssh/authorized_keys with correct permissions
38+
---
39+
40+
## 📷 Screenshots
41+
42+
<div align="center">
43+
44+
### 🚀 Startup
45+
<img src="./docs/loader.png" alt="App starting splash/loader" width="800" />
46+
47+
Clean loading screen when launching the app
48+
49+
---
50+
51+
### 📋 Server Management Dashboard
52+
<img src="./docs/list server.png" alt="Server list view" width="900" />
53+
54+
Main dashboard displaying all configured servers with status indicators, pinned favorites at the top, and easy navigation
55+
56+
---
57+
58+
### 🔎 Search
59+
<img src="./docs/search.png" alt="Fuzzy search servers" width="900" />
60+
61+
Fuzzy search functionality to quickly find servers by name, IP address, or tags
62+
63+
---
64+
65+
### ➕ Add Server
66+
<img src="./docs/add server.png" alt="Add a new server" width="900" />
67+
68+
User-friendly form interface for adding new SSH connections.
69+
70+
---
71+
72+
### 🔐 Connect to server
73+
<img src="./docs/ssh.png" alt="SSH connection details" width="900" />
74+
75+
SSH into the selected server
76+
77+
</div>
78+
3979
---
4080

4181
## 📦 Installation
@@ -76,21 +116,6 @@ make run
76116

77117
---
78118

79-
## ⚙️ Configuration
80-
81-
lazyssh reads your SSH hosts from `~/.ssh/config`. Example entry:
82-
83-
```Host my-server
84-
HostName 203.0.113.10
85-
User ubuntu
86-
Port 22
87-
IdentityFile ~/.ssh/id_ed25519
88-
```
89-
90-
You can add/edit/delete entries from within the UI as well; lazyssh will keep things consistent.
91-
92-
---
93-
94119
## ⌨️ Key Bindings
95120

96121
| Key | Action |
@@ -114,14 +139,24 @@ Tip: The hint bar at the top of the list shows the most useful shortcuts.
114139

115140
---
116141

117-
## 🚀 Quickstart
142+
## 🤝 Contributing
143+
144+
Contributions are welcome!
118145

119-
- Ensure your `~/.ssh/config` contains at least one Host.
120-
- Run the app: `./lazyssh`
121-
- Use `/` to search, `Enter` to connect.
146+
- If you spot a bug or have a feature request, please [open an issue](https://github.com/adembc/lazyssh/issues).
147+
- If you'd like to contribute, fork the repo and submit a pull request ❤️.
148+
149+
We love seeing the community make Lazyssh better 🚀
122150

123151
---
124152

153+
## ⭐ Support
154+
155+
If you find Lazyssh useful, please consider giving the repo a **star** ⭐️ and join [stargazers](https://github.com/adembc/lazyssh/stargazers).
156+
157+
☕ You can also support me by [buying me a coffee](https://www.buymeacoffee.com/adembc) ❤️
158+
159+
---
125160

126161
## 🙏 Acknowledgments
127162

docs/add server.png

49.8 KB
Loading

docs/list server.png

348 KB
Loading

docs/loader.png

48.4 KB
Loading

docs/search.png

161 KB
Loading

docs/ssh.png

23.5 KB
Loading

makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ SHELL = /usr/bin/env bash -o pipefail
1919

2020
# Project variables
2121
PROJECT_NAME ?= $(shell basename $(CURDIR))
22-
VERSION ?= v0.0.1
22+
VERSION ?= v0.1.0
2323
BUILD_TIME ?= $(shell date -u '+%Y-%m-%d_%H:%M:%S')
2424
GIT_COMMIT ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
2525

0 commit comments

Comments
 (0)