2024-07-27 16:23:51 +02:00
|
|
|
# ACHAR
|
2024-07-27 15:57:43 +02:00
|
|
|
|
2024-07-27 16:23:32 +02:00
|
|
|
- Title : ACHAR - Auto Completion of Hosts Add/Remove script
|
2024-08-02 03:43:19 +02:00
|
|
|
- Version : 0.2.2
|
2024-07-27 16:23:32 +02:00
|
|
|
- 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
|
2024-08-02 03:43:19 +02:00
|
|
|
- Description: This tool allows for the management of Bash auto completion of hostnames when using SSH or RSync in Bash.
|
2024-07-27 16:23:32 +02:00
|
|
|
|
2024-07-27 22:37:26 +02:00
|
|
|
## INSTALLATION
|
|
|
|
|
|
|
|
|
|
For most people it will be as simple as this...
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
$ curl https://git.zaks.web.za/zaks-web/achar/raw/branch/main/install | sudo bash
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
If you are already at root level...
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
# curl https://git.zaks.web.za/zaks-web/achar/raw/branch/main/install | bash
|
|
|
|
|
````
|
|
|
|
|
|
2024-07-27 16:23:32 +02:00
|
|
|
## 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
|
|
|
|
|
````
|
|
|
|
|
|
2024-08-02 03:43:19 +02:00
|
|
|
### license
|
|
|
|
|
|
|
|
|
|
Displays the GPL3 and Later license
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
$ achar license
|
|
|
|
|
````
|
|
|
|
|
|
2024-07-27 16:23:32 +02:00
|
|
|
### 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
|
|
|
|
|
````
|
|
|
|
|
|
2024-08-02 03:43:19 +02:00
|
|
|
### reset
|
|
|
|
|
|
|
|
|
|
Deletes all saved hosts
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
$ achar reset
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
### uninstall
|
|
|
|
|
|
|
|
|
|
Uninstalls achar from your system
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
$ sudo achar uninstall
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
# achar uninstall
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
_Does not delete the list of hosts stored at ~/.achar/hosts_
|
|
|
|
|
|
2024-07-27 16:23:32 +02:00
|
|
|
### update
|
|
|
|
|
|
|
|
|
|
Checks for an update to ACHAR and prompts you to install it
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
$ achar update
|
|
|
|
|
````
|
