From e555f209a4cedc75fc98f81692ba8eabe476541f Mon Sep 17 00:00:00 2001 From: Lev Date: Tue, 18 Aug 2015 18:36:38 +0300 Subject: [PATCH] Write up some notes about autocomplete --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a1945aa..bdd8d21 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ Command Line Interface for manilulating the CenturyLink IaaS. Download a binary compiled for your platform from the [releases page](https://github.com/CenturyLinkCloud/clc-go-cli/releases). +## Autocomplete + +### Bash + +Starting from `2015-08-18` the release tarballs contain 2 bash files: `bash_autocomplete` and `install_autocomplete`. You can enable autocomplete for the current terminal session by simply sourcing the former. Or you can install it user-wide by +executing the latter. In this case, the script will put `bash_autocomple` into the `~/.bash_autocomplete` folder +and update `~/.bashrc` accordingly. + ## Getting Help Explore the available resources, commands, options and other useful guidance using the `--help` option: @@ -25,3 +33,5 @@ The documentation of the underlying HTTP API can be found [here](https://www.ctl * Before commit check that `gofmt -d=true ./..` and `go vet ./...` do not produce any output (except for that coming from `Godeps/_workspace` - ignore it) and check that all tests pass via `./run_tests`. If you want to make an executabe, simply run `./build`. The binary will appear in the `./out` folder. + +If you want bash autocomplete to work, you have to use the binary generated by the `./build` command. To turn autocomplete on either source `autocomplete/bash_autocomplete` or install it by running `./install_autocompletion`.