summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-10-23 17:38:54 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-11-21 18:07:44 +0530
commitd2c0f8345fc83e04cfaf3d24b8a3392e6d18c67d (patch)
tree5c779796d85ae5c337e20acb1e1a88b112c36135 /README.md
parent5afc1ab68f9eb20232d02f6b463758637cdda540 (diff)
Move install.sh into zip root folder
Issue-Id: CLI-66 Change-Id: I316788d3f9fc036da71479be7106150b82e25330 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/README.md b/README.md
index 003725ca..18ed70fd 100644
--- a/README.md
+++ b/README.md
@@ -2,20 +2,25 @@ 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 <command>** from linux console.
+Run **oclip <command>** 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 +28,8 @@ 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
-------------------------
+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 +37,7 @@ time. so to choose the product version, set evironment variable
NOTE: In interactive mode, product version can be selected using
typing **use <product-version>**
-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,5 +54,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
-
-