X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=ec82cf5e87829ecc7c539f3ed6b6b32e1f8b9b95;hb=f0c5a4ebf825a34bfaef70d19733721d1d6ceb69;hp=670fbc6f55120366fa272d984930fd76d16cb5e5;hpb=5a7190730d457e7193383d7a2f68f1a849796f2c;p=cli.git diff --git a/README.md b/README.md index 670fbc6f..ec82cf5e 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,59 @@ -ONAP Command-line interface (CLI) -================================== +[comment]: # (# Copyright 2018 Huawei Technologies Co., Ltd.) +[comment]: # (# ) +[comment]: # (Licensed under the Apache License, Version 2.0 (the "License") +[comment]: # (# you may not use this file except in compliance with the License.) +[comment]: # (# You may obtain a copy of the License at) +[comment]: # (#) +[comment]: # (# http://www.apache.org/licenses/LICENSE-2.0) +[comment]: # (#) +[comment]: # (# Unless required by applicable law or agreed to in writing, software) +[comment]: # (# distributed under the License is distributed on an "AS IS" BASIS,) +[comment]: # (# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.) +[comment]: # (# See the License for the specific language governing permissions and) +[comment]: # (# limitations under the License.) -**One Command to command whole Onap !!** +Open Command-line interface Platform (OCLIP) +============================================ -Provides unified commands to operate ONAP from Linux console. -Configure the following environment variables, before using it: +Provides unified commands to operate any cloud enabled software +products from Linux/Web console. -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 following environment variable, before using OCLIP: + +**OPEN_CLI_HOME** - Complete path of directory, where OCLIP is installed. To Run a command ----------------- -Type **onap ** from linux console. +Configure the following environment variables: + +1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL +2. **OPEN_CLI_HOST_USERNAME** - Service user name +3. **OPEN_CLI_HOST_PASSWORD** - Service password + +Run **oclip ** from Linux console. To Run in Interactive mode -------------------------- -Type **onap** from linux console. +Run **oclip** 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 +1. **host-url** - Catalog service URL or a service URL +2. **host-username** - Service user name +3. **host-password** - Service password -Set the product version ------------------------- +NOTE: This mode is available as Web command console when OCLIP is running from docker. + +Select 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**. +**OPEN_CLI_PROUDCT_IN_USE**. 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 +Run *oclip [-v|--version]* to see the available product version details. Set the parameter values ------------------------ @@ -41,15 +61,12 @@ Use the directive 'set' for setting the values for parameters and 'unset' for un Help ---- -*onap [-h|--help]* -*onap [-h|--help]* +*oclip [-h|--help]* +*oclip [-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 \ No newline at end of file +1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true +2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number