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 Set the product version
  22 ------------------------
  23 CLI framework is enhanced to handle multiple product versions at same
  24 time. so to choose the product version, set evironment variable
  25 **CLI_PROUDCT_VERSION**.
  26
  27 NOTE: In interactive mode, product version can be selected using
  28 typing **use <product-version>**
  29
  30 Run *onap [-v|--version]* to see the CLI and available product version details
  31
  32 Help
  33 ----
  34 *onap [-h|--help]*
  35 *onap <command> [-h|--help]*
  36
  37 Debug Mode
  38 ----------
  39 To run in debug mode, set following environment variables:
  40 1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true
  41 2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number
  42
  43 More details
  44 -------------
  45 https://wiki.onap.org