Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ali5ter authored Jan 19, 2022
1 parent 112ef52 commit ac2fc33
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ Assuming a taxonomy can be successfully established, it is output in different w

**Note: While this script can generate a Bash autocomplete script, it is rudimentary. However it can still significantly aid the developer experience of a CLI where tab completion doesn't already exist.**

## Python 2 warning
I have not ported [cli_taxo.py](cli_taxo.py) to Python 3. Keep meaning to. Sorry.

I have found [PyEnv](https://github.com/pyenv/pyenv) very useful to control Python versions and map them to particular folders where I need a certain version to run. For [cli_taxo.py](cli_taxo.py) I use PyEnv to set the local Python version to 2.7.18.

## Usage
Regular expressions are configurable by the user to parse the CLI help documentation and default to expressions that parse the `docker` help - at least the last time it was run. However, to display the taxonomy or `kubectl`, you can run
```
Expand Down Expand Up @@ -93,4 +98,4 @@ Examples of these radial diagrams:

## Other repos that use cli_taxo
* [Install Cloud PKS CLI using homebrew](https://github.com/ali5ter/homebrew-vke-cli) - used by CircleCi build script
* [Cloud PKS CLI bash or zsh completion](https://github.com/ali5ter/vke-completion)
* [Cloud PKS CLI bash or zsh completion](https://github.com/ali5ter/vke-completion)

0 comments on commit ac2fc33

Please sign in to comment.