Skip to content

Commit

Permalink
update docker and kubectl and add diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
ali5ter committed Jun 9, 2020
1 parent 80f9eaa commit 6754a44
Show file tree
Hide file tree
Showing 13 changed files with 1,783 additions and 508 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The [cli_taxo.py](cli_taxo.py) script parses the help documentation for a CLI co

Assuming a taxonomy can be successfully established, it is output in different ways:
* A simple ASCII tree diagram
* Comma seperated values for integration with other tools (like d3js)
* A very simple, headerless, markdown table (useful for use in wiki's or MD docs)
* Comma separated values for integration with other tools (like d3js)
* A very simple, header-less, markdown table (useful for use in wiki's or MD docs)
* A Bash autocompletion script

**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.**
Expand Down Expand Up @@ -76,10 +76,17 @@ Not so much experiments, rather different ways the [cli_taxo.py](cli_taxo.py) sc

[exp2](exp2) ... Scripts to generate CSV output that integrates with a tool to generate a MindMap format file. This can be viewed with tools like [FreeMind](http://freemind.sourceforge.net/wiki/index.php/Main_Page)

[exp3](exp3) ... Scripts to take CSV formats from [exp2](exp2) and generate [radial trees](https://bl.ocks.org/mbostock/4063550) or [dendograms](https://bl.ocks.org/mbostock/4063570). Useful to quickly figure out structural aspsects of the taxo such as density or depth.
[exp3](exp3) ... Scripts to take CSV formats from [exp2](exp2) and generate [radial trees](https://bl.ocks.org/mbostock/4063550) or [dendograms](https://bl.ocks.org/mbostock/4063570). Useful to quickly figure out structural aspects of the taxo such as density or depth.

[exp4](exp4) ... Scripts to generate bash autocompletion scripts using the wrapper scripts in [exp1](exp1)

## Quick start taxo diagrams
As a convenience, a couple of scripts are supplied to regenerate the taxonomy trees for CLI commands that might have been updated and displaying the diagrams for them.

[build_taxo_for](build_taxo_for) runs the required experiments above to generate the taxo tree, csv and diagrams for a specific CLI command that already has supporting scripts.

[show_taxo_for](show_taxo_for) builds and runs the container in [exp3](exp3) to serve the SVG diagrams and opens the URL to the specific CLI commands radial illustration.

## 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)
265 changes: 177 additions & 88 deletions exp1/results/docker_taxo.txt
Original file line number Diff line number Diff line change
@@ -1,89 +1,178 @@
docker
└─ attach
└─ build
└─ commit
└─ cp
└─ create
└─ deploy
└─ diff
└─ events
└─ exec
└─ export
└─ history
└─ images
└─ import
└─ info
└─ inspect
└─ kill
└─ load
└─ login
└─ logout
└─ logs
└─ network
│ └─ connect
│ └─ create
│ └─ disconnect
│ └─ inspect
│ └─ ls
│ └─ rm
└─ node
│ └─ demote
│ └─ inspect
│ └─ ls
│ └─ promote
│ └─ rm
│ └─ ps
│ └─ update
└─ pause
└─ plugin
│ └─ disable
│ └─ enable
│ └─ inspect
│ └─ install
│ └─ ls
│ └─ rm
│ └─ set
│ └─ push
└─ port
└─ ps
└─ pull
└─ push
└─ rename
└─ restart
└─ rm
└─ rmi
└─ run
└─ save
└─ search
└─ service
│ └─ create
│ └─ inspect
│ └─ ps
│ └─ ls
│ └─ rm
│ └─ scale
│ └─ update
└─ stack
│ └─ config
│ └─ deploy
│ └─ rm
│ └─ ps
└─ start
└─ stats
└─ stop
└─ swarm
│ └─ init
│ └─ join
│ └─ update
│ └─ leave
└─ tag
└─ top
└─ unpause
└─ update
└─ version
└─ volume
│ └─ create
│ └─ inspect
│ └─ ls
│ └─ rm
└─ wait
└── builder
│ └── build
│ └── prune
└── checkpoint
│ └── create
│ └── ls
│ └── rm
└── config
│ └── create
│ └── inspect
│ └── ls
│ └── rm
└── container
│ └── attach
│ └── commit
│ └── cp
│ └── create
│ └── diff
│ └── exec
│ └── export
│ └── inspect
│ └── kill
│ └── logs
│ └── ls
│ └── pause
│ └── port
│ └── prune
│ └── rename
│ └── restart
│ └── rm
│ └── run
│ └── start
│ └── stats
│ └── stop
│ └── top
│ └── unpause
│ └── update
│ └── wait
└── context
│ └── create
│ └── export
│ └── import
│ └── inspect
│ └── ls
│ └── rm
│ └── update
│ └── use
└── image
│ └── build
│ └── history
│ └── import
│ └── inspect
│ └── load
│ └── ls
│ └── prune
│ └── pull
│ └── push
│ └── rm
│ └── save
│ └── tag
└── network
│ └── connect
│ └── create
│ └── disconnect
│ └── inspect
│ └── ls
│ └── prune
│ └── rm
└── node
│ └── demote
│ └── inspect
│ └── ls
│ └── promote
│ └── ps
│ └── rm
│ └── update
└── plugin
│ └── create
│ └── disable
│ └── enable
│ └── inspect
│ └── install
│ └── ls
│ └── push
│ └── rm
│ └── set
│ └── upgrade
└── secret
│ └── create
│ └── inspect
│ └── ls
│ └── rm
└── service
│ └── create
│ └── inspect
│ └── logs
│ └── ls
│ └── ps
│ └── rm
│ └── rollback
│ └── scale
│ └── update
└── stack
│ └── deploy
│ └── ls
│ └── ps
│ └── rm
│ └── services
└── swarm
│ └── ca
│ └── init
│ └── join
│ └── leave
│ └── unlock
│ └── update
└── system
│ └── df
│ └── events
│ └── info
│ └── prune
└── trust
│ └── key
│ │ └── generate
│ │ └── load
│ └── signer
│ │ └── add
│ │ └── remove
│ └── inspect
│ └── revoke
│ └── sign
└── volume
│ └── create
│ └── inspect
│ └── ls
│ └── prune
│ └── rm
└── attach
└── build
└── commit
└── cp
└── create
└── deploy
└── diff
└── events
└── exec
└── export
└── history
└── images
└── import
└── info
└── inspect
└── kill
└── load
└── login
└── logout
└── logs
└── pause
└── port
└── ps
└── pull
└── push
└── rename
└── restart
└── rm
└── rmi
└── run
└── save
└── search
└── start
└── stats
└── stop
└── tag
└── top
└── unpause
└── update
└── version
└── wait
Loading

0 comments on commit 6754a44

Please sign in to comment.