README.md

   1 ONAP Command-line interface (CLI)
   2 ==================================
   3
   4 **One Command to command whole Onap !!**
   5
   6 Provides unified commands to operate ONAP from Linux console.
   7 Configure the following environment variables, before using it:
   8
   9 1. **ONAP_HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
  10 2. **ONAP_USERNAME** - Onap user name
  11 3. **ONAP_PASSWORD** - Onap user password
  12
  13 To Run a command
  14 -----------------
  15 Type **onap <command>** from linux console.
  16
  17 To Run in Interactive mode
  18 --------------------------
  19 Type **onap** from linux console.
  20
  21 And use the directive set to set the values for following parameters:
  22
  23 1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
  24 2. **onap-username** - Onap user name
  25 3. **onap-password** - Onap user password
  26
  27 Set the product version
  28 ------------------------
  29 CLI framework is enhanced to handle multiple product versions at same
  30 time. so to choose the product version, set evironment variable
  31 **CLI_PROUDCT_VERSION**.
  32
  33 NOTE: In interactive mode, product version can be selected using
  34 typing **use <product-version>**
  35
  36 Run *onap [-v|--version]* to see the CLI and available product version details
  37
  38 Set the parameter values
  39 ------------------------
  40 Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
  41
  42 Help
  43 ----
  44 *onap [-h|--help]*
  45 *onap <command> [-h|--help]*
  46
  47 Debug Mode
  48 ----------
  49 To run in debug mode, set following environment variables:
  50 1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true
  51 2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
  52
  53 More details
  54 -------------
  55 https://wiki.onap.org