From e2f38b1e962845a543a936b5a0858b1b6ea84339 Mon Sep 17 00:00:00 2001 From: Adem Baccara <71262172+Adembc@users.noreply.github.com> Date: Wed, 27 Aug 2025 19:51:26 +0100 Subject: [PATCH] Revise README with new installation options and demo --- README.md | 45 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d3e4126..8f45bc1 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ 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 + + ## ✨ Features @@ -35,19 +38,41 @@ With lazyssh, you can quickly navigate, connect, manage, and transfer files betw - Automatically append keys to ~/.ssh/authorized_keys with correct permissions --- -## 🛠 Installation +## 📦 Installation -- From source (requires Go 1.22+): - - git clone https://github.com/Adembc/lazyssh.git - - cd lazyssh - - go build -o lazyssh ./cmd - - ./lazyssh --version +### Option 1: Download Binary from Release -- Using make (if available): - - make build - - ./bin/lazyssh +Download the latest release from [GitHub Releases](https://github.com/Adembc/lazyssh/releases): -Binary releases: if/when releases are published, download from the Releases page and place in your PATH. +```bash +# Download and extract (example) +curl -JLO https://github.com/Adembc/lazyssh/releases/download/v0.1.0/lazyssh-darwin-arm64.tar.gz +tar -xzf lazyssh-darwin-arm64.tar.gz + +# Make it executable and move to PATH +chmod +x lazyssh-darwin-arm64 +sudo mv lazyssh-darwin-arm64 /usr/local/bin/lazyssh + +# run it +lazyssh +``` + +### Option 2: Build from Source + +Requires **Go 1.22+** + +```bash +# Clone the repository +git clone https://github.com/Adembc/lazyssh.git +cd lazyssh + +# Build for macOS +make build +./bin/lazyssh + +# Or Run it directly +make run +``` ---