From 9074b5e1653b99f888790d7adc96e36c4b690c43 Mon Sep 17 00:00:00 2001 From: zaks-web Date: Sat, 27 Jul 2024 16:23:32 +0200 Subject: [PATCH] Update README.md --- README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 84 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a3f5e2..d3765e1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,86 @@ # achar -This tool allows for the management of bash auto completion of hostnames when using SSH or RSync in Bash. \ No newline at end of file +- Title : ACHAR - Auto Completion of Hosts Add/Remove script +- Version : 0.1 +- GIT Repo : https://git.zaks.web.za/zaks-web/achar +- Author : Ze'ev Schurmann +- Company : ZAKS Web +- Website : https://www.zaks.web.za/ +- Reddit : https://www.reddit.com/r/ZAKSWeb +- License : GPL3 or Later +- Description: This tool allows for the management of bash auto completion of hostnames when using SSH or RSync in Bash. + +## USAGE + +From the bash terminal, type: + +```` +$ achar {command} {hostname} +```` + +## COMMANDS + +### add + +Adds a host to your list of common hosts + +```` +$ achar add username@hostname.domainname.tld +$ achar add username@1.2.3.4 +```` + +### disable + +Disables auto completion of hostnames for current system user + +```` +$ achar disable +```` + +### enable + +Enables auto completion of hostnames for current system user + +```` +$ achar enable +```` + +### help + +Displays the help documentation + +```` +$ achar help +```` + +### list + +List all existing hosts from your list of common hosts + +```` +$ achar list +```` + +You can use also filter for a specific hostname/username or part there of + +```` +$ achar list part-of-username +$ achar list part-of-hostname +```` + +### remove + +Removes an existing host from your list of common hosts + +```` +$ achar remove username@hostname.domainname.tld +$ achar remove username@1.2.3.4 +```` + +### update + +Checks for an update to ACHAR and prompts you to install it + +```` +$ achar update +````