README.md

cleos-auto-completion

• UPDATED TO EOSIO v1.8.6
• UPDATED TO EOSIO v1.7.0 (REX support)

Because of the limit of CLI11(commandline parser for c++) used by cleos, currently cleos do not provide command auto-complete functionality. With this project, you can use command auto-completion feature to your cleos. Also, you can use this for your custom cleos shell files with simple changes(which is described below).

For now, We support BASH and ZSH (see below). But others will be supported soon.

Installation (BASH)

Just clone this repo and append source command line inside of your environment file. To make it work immediately, execute source command or restart your bash shell.

$ git clone https://github.com/Hexlant/cleos-auto-completion.git
$ cd cleos-auto-completion
$ echo "source $(pwd)/cleos.bash" >> ~/.bashrc

for immediate working..

$ source $(pwd)/cleos.bash

Installation (ZSH)

For zsh, we can use bashcompinit which can use bash-completion features in your zsh. Clone this repo and append command lines inside of your environment file.

edit .zshrc to use bashcompinit

(Append below lines in your '.zshrc')
autoload bashcompinit
bashcompinit

clone repo

$ git clone https://github.com/Hexlant/cleos-auto-completion.git
$ cd cleos-auto-completion
$ echo "source $(pwd)/cleos.bash" >> ~/.zshrc

finally, your .zshrc will be similar to the following.

(...)
autoload bashcompinit
bashcompinit
source /home/sam/cleos-auto-completion/cleos.bash

for immediate working..

$ source $(pwd)/cleos.bash

Customization

for custom cleos shell files

If you're using your own cloes shell file, add your file names at $CLEOS_TARGET_NAME before installation step. You can find this at line 10.

(BEFORE)
CLEOS_TARGET_NAME=(cleos)

(AFTER)
CLEOS_TARGET_NAME=(./cleos_local.sh ./cleos_mainnet.sh)

Contribution

We always welcome contributions. Feel free to make pull request or report issues! :)