From 967b246f4ca0f3cf017047f26c2876c49e824ef1 Mon Sep 17 00:00:00 2001 From: MatMoul Date: Mon, 27 Apr 2026 22:16:05 +0200 Subject: [PATCH] docs: add usage and examples for sshrm --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index f063cc9..3d1364a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # sshrm +Remove an entry from `~/.ssh/known_hosts` by host name or by line number. + +## Usage + +```bash +sshrm [OPTION]... HOST|LINE +``` + +## Options + +- `-h`, `--help` Show help and exit. + +## Examples + +Remove by host: + +```bash +sshrm example.com +``` + +Remove by line number: + +```bash +sshrm 12 +``` + +## Notes + +- Line numbers must be positive integers. +- The script edits `~/.ssh/known_hosts`. +- Keep a backup if you need to recover entries. +