X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=670fbc6f55120366fa272d984930fd76d16cb5e5;hb=db0a6497b5b4159c16f907ae91c2a4ce0281c2bc;hp=b1ef55d18bd6a2e079f64e5938708ccb182bf302;hpb=56ecabe9f1e7fca51d919df2836811b378c0e7df;p=cli.git diff --git a/README.md b/README.md index b1ef55d1..670fbc6f 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,55 @@ -Onap Command-line interface (CLI). +ONAP Command-line interface (CLI) +================================== -One Command to command whole Onap !! It provides the unified commands -to access and operate Onap functionalities. To use this CLI, please -configure the following environment variables: +**One Command to command whole Onap !!** -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 +Provides unified commands to operate ONAP from Linux console. +Configure the following environment variables, before using it: -To know the CLI version, type onap [-v|--version] -To know the CLI usage, type onap [-h|--help] -To know the usage of sub commands, type onap [-h|--help] +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 ** 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. **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 ** + +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 [-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 -To know more, please refer the Onap wiki https://wiki.onap.org +More details +------------- +https://wiki.onap.org \ No newline at end of file