This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git
The following commit(s) were added to refs/heads/master by this push:
new 2fb3c60 WIP.
2fb3c60 is described below
commit 2fb3c60daeaf6240bc17d8b941cdd932760ba3de
Author: Aaron Radzinski <[email protected]>
AuthorDate: Mon Jan 4 01:31:16 2021 -0800
WIP.
---
images/cli1.png | Bin 12823 -> 20366 bytes
images/cli2.png | Bin 77336 -> 106437 bytes
images/cli7.png | Bin 72146 -> 95497 bytes
tools/script.html | 34 ++++++++++++++++++++++++----------
4 files changed, 24 insertions(+), 10 deletions(-)
diff --git a/images/cli1.png b/images/cli1.png
index ec387b1..467fe0b 100644
Binary files a/images/cli1.png and b/images/cli1.png differ
diff --git a/images/cli2.png b/images/cli2.png
index 9788c6c..c7027cd 100644
Binary files a/images/cli2.png and b/images/cli2.png differ
diff --git a/images/cli7.png b/images/cli7.png
index 9b1d851..7da4fa5 100644
Binary files a/images/cli7.png and b/images/cli7.png differ
diff --git a/tools/script.html b/tools/script.html
index 6d351f7..e672745 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -25,10 +25,10 @@ id: script
<section id="overview">
<h2 class="section-title">Overview</h2>
<p>
- <code>bin/nlpcraft.{sh|cmd}</code> script is a <b>central
management utility</b> for NLPCraft. Most
- of the functions this script does can be done through running
- Java applications - yet using this script you can accomplish the
same things much simpler and quicker.
- From starting and managing REST server, running various built-in
tools, to testing models via REST API -
+ <code>bin/nlpcraft.{sh|cmd}</code> script is a <b>central
management utility</b> for NLPCraft that supports
+ REPL (interactive) and command line modes. Most of the functions
this script does can be done through running
+ Java applications or using REST API - yet using this script you
can perform the same tasks much simpler and quicker.
+ From starting and managing REST server and probes, running various
built-in tools, to testing models via REST API -
<code>bin/nlpcraft.{sh|cmd}</code> script provides a single
centralized utility that makes a quick work out
of all these routine tasks.
</p>
@@ -47,8 +47,8 @@ id: script
</div>
<p>
The script is located in <code>/bin</code> sub-folder of the
installation root and is available for
- Unix/Linux (<code>nlpcraft.sh</code>) and Windows
(<code>nlpcraft.cmd</code>) environments. We will use
- <code>.sh</code> version for the rest of instructions unless
specified otherwise.
+ Unix/Linux (<code>nlpcraft.sh</code>) and Windows
(<code>nlpcraft.cmd</code>) environments. Both versions
+ provide identical functionality.
</p>
</section>
<section id="quick_start">
@@ -75,8 +75,25 @@ id: script
<img class="non-fluid-img" src="/images/cli1.png" alt="">
</p>
<p>
- Script starts in the REPL mode by default.
+ Script starts in the REPL mode by default. Note that in REPL mode
the command prompt always shows REST
+ server status, local probe status, REST access token (if any) as
well as current working directory.
</p>
+ <div class="bq info">
+ <b>REPL Prompt</b>
+ <p>
+ REPL prompt shows 4 pieces of information:
+ </p>
+ <ul>
+ <li>REST server status (<code>ON</code> if server is started
and detected, <code>OFF</code> otherwise).</li>
+ <li>Local probe status (<code>ON</code> if probe is started
and connected to the server, <code>OFF</code> otherwise).</li>
+ <li>REST access token if the user is signed in. This token is
required for all REST calls.</li>
+ <li>Current user working directory.</li>
+ </ul>
+ <p>
+ Note that when using <code>start-server</code> command the
default user account is automatically signed in
+ upon server start and the access token is obtained. You can
sign in with different user account, if necessary.
+ </p>
+ </div>
<h2 class="section-sub-title">Get Command List</h2>
<p>
Type <code>help</code> to list all supported commands (or run
<code>bin/nlpcraft.sh help</code> if in command line mode):
@@ -96,9 +113,6 @@ id: script
Use <span class="keyboard">↑</span> and <span
class="keyboard">↓</span> keys to scroll through command history.
</p>
<p>
- <img class="non-fluid-img" alt="" src="/images/cli8.png">
- </p>
- <p>
To exit <code>bin/nlpcraft.{sh|cmd}</code> script in REPL mode
type <code>quit</code>.
</p>
</section>
