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. +