summaryrefslogtreecommitdiffstats
path: root/deployment
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-08-31 15:33:29 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2017-08-31 15:48:26 +0530
commite35db04d37e98688c20c6f42fff0c5ce892aa728 (patch)
tree045c183ddccf4bb4ba4237ab5158a2e706347e4b /deployment
parent8de208f3e785f7bf160f4f4413b53bbd91417806 (diff)
Make interactive mode as default
CLI-37 Change-Id: Ic1ea32d4d38a46652de3fe7840391e76bc35a934 Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'deployment')
-rw-r--r--deployment/http/web/index.html47
-rw-r--r--deployment/http/web/onap-cli.pngbin0 -> 29672 bytes
2 files changed, 37 insertions, 10 deletions
diff --git a/deployment/http/web/index.html b/deployment/http/web/index.html
index f44cc907..ea2491a9 100644
--- a/deployment/http/web/index.html
+++ b/deployment/http/web/index.html
@@ -1,10 +1,37 @@
-<!DOCTYPE html>
-<html>
-<head>
- <title>ONAP CLI</title>
- <meta charset="UTF-8">
-</head>
-<body>
-Please download ONAP CLI from <a href="./cli-1.0.0-SNAPSHOT.zip">here</a>
-</body>
-</html>
+<!DOCTYPE html><html><head><link rel="icon" href="./onap-cli.png">
+<meta charset="utf-8"><title>ONAP CLI</title><style></style></head><body id="preview">
+<h1><a id="ONAP_Commandline_interface_CLI_0"></a>ONAP Command-line interface (CLI)</h1>
+<p style="color:blue"><strong>One Command to command whole Onap !!</strong></p>
+<p>Provides unified commands to operate ONAP from Linux console.<br>
+Configure the following environment variables, before using it:</p>
+<ol>
+<li><strong>ONAP_HOST_URL</strong> - Onap Micro service bus(MSB) URL or a service URL</li>
+<li><strong>ONAP_USERNAME</strong> - Onap user name</li>
+<li><strong>ONAP_PASSWORD</strong> - Onap user password</li>
+</ol>
+<h2><a id="To_Run_a_command_12"></a>To Run a command</h2>
+<p>Type <strong>onap &lt;command&gt;</strong> from linux console.</p>
+<h2><a id="To_Run_in_Interactive_mode_16"></a>To Run in Interactive mode</h2>
+<p>Type <strong>onap</strong> from linux console</p>
+<h2><a id="Set_the_product_version_20"></a>Set the product version</h2>
+<p>CLI framework is enhanced to handle multiple product versions at same<br>
+time. so to choose the product version, set evironment variable<br>
+<strong>CLI_PROUDCT_VERSION</strong>.</p>
+<p>NOTE: In interactive mode, product version can be selected using<br>
+typing <strong>use &lt;product-version&gt;</strong></p>
+<p>Run <em>onap [-v|–version]</em> to see the CLI and available product version details</p>
+<h2><a id="Help_31"></a>Help</h2>
+<p><em>onap [-h|–help]</em><br>
+<em>onap &lt;command&gt; [-h|–help]</em></p>
+<h2><a id="Debug_Mode_36"></a>Debug Mode</h2>
+<p>To run in debug mode, set following environment variables:</p>
+<ol>
+<li>ONAP_CLI_DEBUG - By default its false, otherwise Set to true</li>
+<li>ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number</li>
+</ol>
+<h2><a id="More_details_42"></a>More details</h2>
+<p><a href="https://wiki.onap.org">https://wiki.onap.org</a></p>
+
+<h2><a id="Download_42"></a>To download</h2>
+<p style="color:red">Please download ONAP CLI <a href="./cli-1.0.0-SNAPSHOT.zip">here</a></p>
+</body></html> \ No newline at end of file
diff --git a/deployment/http/web/onap-cli.png b/deployment/http/web/onap-cli.png
new file mode 100644
index 00000000..60c3e151
--- /dev/null
+++ b/deployment/http/web/onap-cli.png
Binary files differ