parallelvirtualcluster/pvc
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases 115 Wiki Activity

Add configuration section to CLI manual

Browse Source
This commit is contained in:
Joshua Boniface
2019-07-28 18:22:46 -04:00
parent 67704198e4
commit 8daafa150c
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manuals/cli.md
View File

@@ -3,3 +3,7 @@
The PVC CLI client is built with Click, a Python framework for creating self-documenting CLI applications. It interfaces directly with the Zookeeper cluster to send and receive information about the cluster with no authentication. The PVC CLI client is built with Click, a Python framework for creating self-documenting CLI applications. It interfaces directly with the Zookeeper cluster to send and receive information about the cluster with no authentication.
Use the `-h` option at any level of the `pvc` CLI command to receive help about the available commands and options. Use the `-h` option at any level of the `pvc` CLI command to receive help about the available commands and options.
## Configuration
The CLI client requires no configuration file. The only optional external environment variable is `PVC_ZOOKEEPER_HOST`, which accepts a Zookeeper connection string and replaces the argument `-z` to the CLI command.