You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2020/11/20 20:27:01 UTC
[incubator-nlpcraft-website] branch master updated (c8dd414 ->
2610136)
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft-website.git.
from c8dd414 Update script.html
new 866586f WIP on nlpcraft.{sh|cmd} docs.
new 2610136 Update script.html
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
_scss/misc.scss | 16 ++++++++++-
images/cli1.png | Bin 0 -> 12226 bytes
images/cli2.png | Bin 0 -> 82124 bytes
images/cli3.png | Bin 0 -> 84110 bytes
tools/script.html | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
5 files changed, 96 insertions(+), 2 deletions(-)
create mode 100644 images/cli1.png
create mode 100644 images/cli2.png
create mode 100644 images/cli3.png
[incubator-nlpcraft-website] 02/02: Update script.html
Posted by ar...@apache.org.
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
commit 26101368bdd0a4d83eabee1a7676f3a10ac399eb
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Fri Nov 20 12:26:31 2020 -0800
Update script.html
---
tools/script.html | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/tools/script.html b/tools/script.html
index 64bc642..0ef1789 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -126,6 +126,14 @@ id: script
</li>
<li>
<b>REPL Commands:</b>
+ <p>
+ REPL commands are set of utilities that you can use while in REPL mode. Although all of these commands, as always,
+ can be executed in the command like mode - they make most sense in REPL mode (except for <code>help</code> command). When running <code>help</code>
+ command the list of REPL commands is available under <b>REPL Commands</b> heading.
+ </p>
+ <p>
+ Note that <code>nano</code> command may not be available on all OS.
+ </p>
</li>
<li>
<b>Miscellaneous Tools:</b>
[incubator-nlpcraft-website] 01/02: WIP on nlpcraft.{sh|cmd} docs.
Posted by ar...@apache.org.
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
commit 866586ffc5946d6fa0cf4cf891111001b43be6d5
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Thu Nov 19 20:05:51 2020 -0800
WIP on nlpcraft.{sh|cmd} docs.
---
_scss/misc.scss | 16 +++++++++++-
images/cli1.png | Bin 0 -> 12226 bytes
images/cli2.png | Bin 0 -> 82124 bytes
images/cli3.png | Bin 0 -> 84110 bytes
tools/script.html | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
5 files changed, 88 insertions(+), 2 deletions(-)
diff --git a/_scss/misc.scss b/_scss/misc.scss
index 819c67d..3f22a68 100644
--- a/_scss/misc.scss
+++ b/_scss/misc.scss
@@ -400,8 +400,22 @@ code {
width: 100% !important;
}
+.non-fluid-img {
+ border-radius: 6px;
+}
+
+.keyboard {
+ padding: 1px 8px;
+ background-color: #2c2c29;
+ color: #efefef;
+ border-radius: 4px;
+ display: inline-block;
+ font-family: monospace;
+ font-weight: 600;
+}
+
.img-fluid-no-border {
max-width: 900px !important;
- border-radius: 4px;
+ border-radius: 6px;
padding: 0 !important;
}
diff --git a/images/cli1.png b/images/cli1.png
new file mode 100644
index 0000000..47401c0
Binary files /dev/null and b/images/cli1.png differ
diff --git a/images/cli2.png b/images/cli2.png
new file mode 100644
index 0000000..a4abf8b
Binary files /dev/null and b/images/cli2.png differ
diff --git a/images/cli3.png b/images/cli3.png
new file mode 100644
index 0000000..b44cff4
Binary files /dev/null and b/images/cli3.png differ
diff --git a/tools/script.html b/tools/script.html
index d39b03d..64bc642 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -53,12 +53,84 @@ id: script
</section>
<section id="quick_start">
<h2 class="section-title">Quick Start</h2>
+ <p>
+ The <code>bin/nlpcraft.{sh|cmd}</code> script can work in two modes:
+ </p>
+ <ul>
+ <li>
+ Command line mode where it executes a single given command at a time.
+ </li>
+ <li>
+ Interactive REPL mode. To enter REPL mode run <code>bin/nlpcraft.sh</code> without any arguments.
+ </li>
+ </ul>
+ <p>
+ All the functionality remains the same regardless of whether each command is executed separately or
+ interactively in REPL mode. To get started, run <code>bin/nlpcraft.sh</code> without any arguments:
+ </p>
+ <p>
+ <img class="non-fluid-img" src="/images/cli1.png" alt="">
+ </p>
+ <p>
+ Script starts in the REPL mode by default. You can use <span class="keyboard">Tab</span> key anytime for auto-suggestion and auto-completion
+ while in REPL mode. Type <code>help</code> to list of all supported commands:
+ </p>
+ <p>
+ <img class="non-fluid-img" src="/images/cli2.png" alt="">
+ </p>
</section>
<section id="usage">
<h2 class="section-title">Usage</h2>
<p>
-
+ Commands supported by the <code>bin/nlpcraft.{sh|cmd}</code> script fall into 4 categories:
</p>
+ <ol>
+ <li>
+ <b>Server Commands.</b><br/>
+ <p>
+ Server commands allow to manage locally run REST server. Note that these commands only work for the REST
+ server that runs on the same host as script. In other words, these commands cannot manage the remote REST
+ server.
+ </p>
+ <p>
+ REST server is a "fire-and-forget" component. During model development you will likely start the
+ server only once and check its output from time to time as most of the work will be happening in the data probe
+ that hosts your models.
+ </p>
+ <p>
+ For example, <code>start-server</code> command provide the easiest and quickest way to start the REST server (with
+ default configuration by default):
+ </p>
+ <p>
+ <img alt="" src="/images/cli3.png">
+ </p>
+ <p>
+ Note that when <code>start-server</code> commands completes it shows all connected probes (none in this example)
+ and automatically signs in with the default <code>admin@admin.com</code> user account so that you can proceed
+ to testing and working with your model right away.
+ </p>
+ <div class="bq info">
+ <b>REPL Prompt</b>
+ <p>
+ REPL prompt shows 3 pieces of information:
+ </p>
+ <ul>
+ <li>REST server status (<code>ON</code> if server is started and detected, <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>
+ </div>
+ </li>
+ <li>
+ <b>REST Commands:</b>
+ </li>
+ <li>
+ <b>REPL Commands:</b>
+ </li>
+ <li>
+ <b>Miscellaneous Tools:</b>
+ </li>
+ </ol>
</section>
</div>
<div class="col-md-2 third-column">