Skip to content

Commit

Permalink
Write up some notes about autocomplete
Browse files Browse the repository at this point in the history
  • Loading branch information
ldmberman committed Aug 18, 2015
1 parent ca2d812 commit e555f20
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`.

0 comments on commit e555f20

Please sign in to comment.