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. Configure the following environment
   6 variables, before using it:
   7
   8 1. **OPEN_CLI_HOST_URL** - Catalog service URL or a service URL
   9 2. **OPEN_CLI_HOST_USERNAME** - Service user name
  10 3. **OPEN_CLI_HOST_PASSWORD** - Service password
  11
  12 To Run a command
  13 -----------------
  14 Type **oclip <command>** from linux console.
  15
  16 To Run in Interactive mode
  17 --------------------------
  18 Type **oclip** from linux console.
  19
  20 And use the directive set to set the values for following parameters:
  21
  22 1. **host-url** - Catalog service URL or a service URL
  23 2. **host-username** - Service user name
  24 3. **host-password** - Service password
  25
  26 Set the product version
  27 ------------------------
  28 CLI framework is enhanced to handle multiple product versions at same
  29 time. so to choose the product version, set evironment variable
  30 **OPEN_CLI_PROUDCT_IN_USE**.
  31
  32 NOTE: In interactive mode, product version can be selected using
  33 typing **use <product-version>**
  34
  35 Run *oclip [-v|--version]* to see the CLI and available product version details
  36
  37 Set the parameter values
  38 ------------------------
  39 Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
  40
  41 Help
  42 ----
  43 *oclip [-h|--help]*
  44 *oclip <command> [-h|--help]*
  45
  46 Debug Mode
  47 ----------
  48 To run in debug mode, set following environment variables:
  49
  50 1. OPEN_CLI_DEBUG - By default its false, otherwise Set to true
  51 2. OPEN_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
  52
  53