diff options
| author |   Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-09-26 11:31:05 +0530 |
|---|---|---|
| committer | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-09-26 11:35:53 +0530 |
| commit | 9893037362ba38286b15592ec92ab23b201493b3 (patch) | |
| tree | cba50ee8aa82d0d8e138946f0c8a51e80346cf49 /docs/user_guide.rst | |
| parent | baf26eff73588b236d5c1261b462d76f8998838b (diff) | |
Add command help document
CLI-34
Change-Id: I8c61343369fbc6893425ba5368959e63546b5cac
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs/user_guide.rst')
| -rw-r--r-- | docs/user_guide.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 8015b861..0bd92650 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -5,3 +5,63 @@ CLI user guide ============== + +.. toctree:: + :maxdepth: 1 + +**One Command to command whole Onap !!** + +Provides unified commands to operate ONAP from Linux console. +Configure the following environment variables, before using it: + +1. **ONAP_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL +2. **ONAP_USERNAME** - Onap user name +3. **ONAP_PASSWORD** - Onap user password + +To Run a command +----------------- +Type **onap <command>** from linux console. + +To Run in Interactive mode +-------------------------- +Type **onap** from linux console. + +And use the directive set to set the values for following parameters: + +1. **onap-host-url** - Onap Micro service bus(MSB) URL or a service URL +2. **onap-username** - Onap user name +3. **onap-password** - Onap user password + +Set the product version +------------------------ +CLI framework is enhanced to handle multiple product versions at same +time. so to choose the product version, set evironment variable +**CLI_PROUDCT_VERSION**. + +NOTE: In interactive mode, product version can be selected using +typing **use <product-version>** + +Run *onap [-v|--version]* to see the CLI and available product version details + +Set the parameter values +------------------------ +Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values. + +Help +---- +*onap [-h|--help]* +*onap <command> [-h|--help]* + +Debug Mode +---------- +To run in debug mode, set following environment variables: +1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true +2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number + +More details +------------- +https://wiki.onap.org + +Command usage guide +------------------- + cmd_help.rst |