README.md

   1 Open Command-line interface Platform (OCLIP)
   2 ============================================
   3
   4 Provides unified commands to operate any cloud enabled software
   5 products from Linux/Web console.
   6
   7 Set the following environment variable, before using OCLIP:
   8
   9 **OPEN_CLI_HOME** - Complete path of directory, where OCLIP is installed.
  10
  11 To Run a command
  12 -----------------
  13 Configure the following environment variables:
  14
  15 1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL
  16 2. **OPEN_CLI_HOST_USERNAME** - Service user name
  17 3. **OPEN_CLI_HOST_PASSWORD** - Service password
  18
  19 Run **oclip <command>** from Linux console.
  20
  21 To Run in Interactive mode
  22 --------------------------
  23 Run **oclip** from Linux console.
  24
  25 And use the directive set to set the values for following parameters:
  26
  27 1. **host-url** - Catalog service URL or a service URL
  28 2. **host-username** - Service user name
  29 3. **host-password** - Service password
  30
  31 NOTE: This mode is available as Web command console when OCLIP is running from docker.
  32
  33 Select the product version
  34 --------------------------
  35 CLI framework is enhanced to handle multiple product versions at same
  36 time. so to choose the product version, set evironment variable
  37 **OPEN_CLI_PROUDCT_IN_USE**.
  38
  39 NOTE: In interactive mode, product version can be selected using
  40 typing **use <product-version>**
  41
  42 Run *oclip [-v|--version]* to see the available product version details.
  43
  44 Set the parameter values
  45 ------------------------
  46 Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
  47
  48 Help
  49 ----
  50 *oclip [-h|--help]*
  51 *oclip <command> [-h|--help]*
  52
  53 Debug Mode
  54 ----------
  55 To run in debug mode, set following environment variables:
  56
  57 1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
  58 2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number