https://github.com/hexlant/cleos-auto-completion

Command auto-completion for EOS cleos.
https://github.com/hexlant/cleos-auto-completion

Last synced: about 1 month ago
JSON representation

Command auto-completion for EOS cleos.

• Host: GitHub
• URL: https://github.com/hexlant/cleos-auto-completion
• Owner: Hexlant
• License: mit
• Created: 2018-07-10T02:55:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-15T13:20:01.000Z (almost 5 years ago)
• Last Synced: 2024-01-25T05:11:17.261Z (11 months ago)
• Language: Shell
• Size: 251 KB
• Stars: 30
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eos - Cleos Auto Completion - Command auto completion features for EOS Cleos. (Tools)
• awesome-eosio - cleos-auto-completion - Command auto-completion for EOSIO cleos. (Developers / Other in Developers)

README

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

```bash

$ git clone https://github.com/Hexlant/cleos-auto-completion.git

$ cd cleos-auto-completion

$ echo "source $(pwd)/cleos.bash" >> ~/.bashrc

```

for immediate working..

```bash

$ 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

```zsh

(Append below lines in your '.zshrc')

autoload bashcompinit

bashcompinit

```

clone repo

```zsh

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

```zsh

(...)

autoload bashcompinit

bashcompinit

source /home/sam/cleos-auto-completion/cleos.bash

```

for immediate working..

```bash

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

```bash

(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! :)