toddhalfpenny / cci-cli-bash-completion

Auto-completion for the Cumulus CI CLI for bash

cci-cli-bash-completion

Auto-completion for the Cumulus CI CLI for bash.

Inspired by the salesforce-cli-bash-completion project by Wade Wegner.

Props to the Cumulus CI team (and all that are part of Salesforce.org).

Installation

Clone this repository, and move to it's directory:

git clone https://github.com/toddhalfpenny/cci-cli-bash-completion && cd cci-cli-bash-completion

Update your .bash_profile (or .bashrc if that's what you have, eg in Ubuntu. Replace below as needed):

printf "\nsource '"$(pwd)"/cci.bash'\n" >> ~/.bash_profile

Reload your profile:

source ~/.bash_profile

Enjoy!

Why have this, when the CCI CLI lib (click) can provide this out of the box?

Well, I didn't know it could, when I first wrote this... but it can, and you can try it with the instructions here. Something I did note when testing this is that the complettion has a significant lag (at least half a second) when using the route defined on this page.

If you want to try it yourself, just run this (before running this project's installation instructions, of course).

eval "$(_CCI_COMPLETE=source_bash cci)"

Roadmap / To-do

1. Auto complete FLOW_NAME for commands like cci flow run [OPTIONS] FLOW_NAME
2. Auto complete TASK_NAME for commands like cci task run [OPTIONS] FLOW_NAME
3. Auto complete ORG_NAME for commands like cci org connect [OPTIONS] FLOW_NAME