X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=ec82cf5e87829ecc7c539f3ed6b6b32e1f8b9b95;hb=128f3cfe7cbaf1139240a0e597f2d2f60c6e1a42;hp=a400bb0c124b853f2dae6c52417fad9afebdd4bd;hpb=df2716420918b03320c1ecdfd722cf5a85bac280;p=cli.git diff --git a/README.md b/README.md index a400bb0c..ec82cf5e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,40 @@ -OPEN 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.) + +Open Command-line interface Platform (OCLIP) +============================================ Provides unified commands to operate any cloud enabled software -products from Linux/Web console. Configure the following environment -variables, before using it: +products from Linux/Web console. + +Set the following environment variable, before using OCLIP: + +**OPEN_CLI_HOME** - Complete path of directory, where OCLIP is installed. + +To Run a command +----------------- +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 -To Run a command ------------------ -Type **oclip ** from linux console. +Run **oclip ** from Linux console. To Run in Interactive mode -------------------------- -Type **oclip** from linux console. +Run **oclip** from Linux console. And use the directive set to set the values for following parameters: @@ -23,8 +42,10 @@ And use the directive set to set the values for following parameters: 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 **OPEN_CLI_PROUDCT_IN_USE**. @@ -32,7 +53,7 @@ time. so to choose the product version, set evironment variable NOTE: In interactive mode, product version can be selected using typing **use ** -Run *oclip [-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 ------------------------ @@ -49,10 +70,3 @@ To run in debug mode, set following environment variables: 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 - -

More details

-

https://wiki.onap.org

- -

To download

-

Please download Open CLI Platform here

-