Add 'Get Instance output' section

Author: a-tylenda

README.md

@@ -55,7 +55,7 @@ STH allows you to deploy and run multiple data processing apps called Sequences.
     <strong>Sequences</strong>
 </summary>
 
-**Sequences** are specific apps, not just any apps. They specialize in efficient data processing.
+[**Sequences**](dictionary.md#sequence) are specific apps, not just any apps. They specialize in efficient data processing.
 
 We named our apps "Sequences" and that term describes well its nature, as they process data through a Sequence of chained functions. Therefore, usually our Sequences are concise, easy to write and powerful at the same time.
 </details>
@@ -76,10 +76,10 @@ What we also do on the host level is that we apply a set of algorithms to optimi
 
 > We call our processing optimization algorithms **"IFCA"** meaning "Intelligent Function Composition Algorithms".
 
-You can interact with host using our dedicated STH CLI that will help you with Sequences deployment, running it and monitoring.
+You can interact with host using our dedicated STH CLI that will help you with Sequences deployment, running and monitoring.
 </details>
 <br>
-Our vanilla STH engine is based on Node.js and thus allows developers to benefit from rich ecosystem, numerous packages and solutions provided by this vibrant community.
+Our vanilla STH engine is based on Node.js and thus allows developers to benefit from its rich ecosystem, numerous packages and solutions provided by this vibrant community.
 
 ### **1.2 Solution concept diagram**
 
@@ -108,7 +108,7 @@ Our vanilla STH engine is based on Node.js and thus allows developers to benefit
 
 This is a solution for the central processing and management unit with the following major components:
 
-1. **Sequences** - these are the actual "STH" apps. It is a gzipped package (`*.tar.gz`) containing at least two files:
+1. **Sequences** - these are the actual "STH" apps. It is a package containing at least two files:
     * **package.json** - JSON manifest file describing the app and its configuration; such as main file to run
     * **main file** - file such as `index.js` or `index.ts` that contains a lightweight application business logic.
 2. **Instance** - once a Sequence is run, the host will create a separate runtime environment for it and will execute Sequence code inside this runtime entity. This is an Instance.
@@ -125,8 +125,8 @@ Our engine outputs can be managed in several ways:
 
 * **File** - you can save your output to a local or a remote file
 * **STDOUT** - output can be directed to system STDOUT (STDERR is supported as well)
-* **API** - output can be consumed from our  STH REST API
-* **URL Request** - you can write your app in a way to request URL, webhook etc
+* **API** - output can be consumed from our STH REST API
+* **URL Request** - you can write your app in a way to request URL, webhook, etc.
 * **Stream** - output can be streamed to a particular destination
 * you can mix multiple actions together: you can both send data to remote system/URL and save it locally.
 
@@ -159,6 +159,7 @@ scramjet-transform-hub
 ```
 
 > 💡 **HINT:** There is also an alias for running STH:
+>
 >```bash
 >sth
 >```
@@ -169,7 +170,7 @@ More detailed installation instructions can be found in our [STH GitHub reposito
 
 ### **3.1 Review the package**
 
-Before running our first Sequence let's have a quick look what's inside the Sequence package.
+Before running your first Sequence let's have a quick look what's inside the Sequence package.
 
 We have prepared for you a simple JavaScript sample Sequence "hello-snowman". This Sequence is available in the directory `samples/hello-snowman` in this repository. In this directory you will find two files:
 
@@ -254,13 +255,22 @@ Now we have uploaded Sequence to the host and host assigned to it a random ID (G
     <strong>3. Run the Sequence</strong>
 </summary>
 
-We can now use Sequence ID to start uploaded Sequence. The command is `si seq start <sequence_id>`. You can also pass arbitrary number of parameters by providing them after `<sequence_id>`, in case of our `hello-snowman` no parameters are used.
+We can now use Sequence ID to start uploaded Sequence. The command is `si seq start <sequence_id>`. To make our users life easier we provided an alias for Sequence ID: `si seq start -`. This CLI functionality replaces `-` argument with the last item the user interacted with or `select`ed.
+
+Also, an arbitrary number of parameters can be passed to a Sequence while `start`ing by providing them after `<sequence_id>` or `-` alias. In case of our `hello-snowman` no parameters are used.
+
 Use the following command to start the Sequence:
 
 ```bash
 si sequence start cf775cc1-105b-473d-b929-6885a0c2182c
 ```
 
+or
+
+```bash
+si sequence start -
+```
+
 The output will look similar to this one:
 
 ```bash
@@ -336,7 +346,7 @@ Our Sequence generator app does two things here:
 * Sends stream of messages; each one containing number with temperature value
 * Reads output from Host API that is generated by our `hello-snowman` Sequence
 
-Separately, you can also open a new terminal window and see log of this particular Instance with command `si instance log <instance_id>`. In our case this would be:
+Separately, you can also open a new terminal window and see log of this particular Instance with command `si instance log <instance_id>` or by using alias `si instance log -`. In our case this would be:
 
 ```bash
 si instance log e70222d1-acfc-4e00-b046-4a3a9481c53b
@@ -345,18 +355,72 @@ si instance log e70222d1-acfc-4e00-b046-4a3a9481c53b
 The sample output will be similar to this one:
 
 ```bash
+Request ok: http://127.0.0.1:8000/api/v1/instance/e70222d1-acfc-4e00-b046-4a3a9481c53b/log status: 200 OK
+{"level":"DEBUG","msg":"Streams initialized","ts":1647447631103,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
+{"level":"TRACE","msg":"Handshake sent","ts":1647447631103,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
+{"level":"DEBUG","msg":"Control message received","ts":1647447631113,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[4000,{"appConfig":{},"args":[]}]}
+{"level":"DEBUG","msg":"Handshake received","ts":1647447631113,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
+{"level":"DEBUG","msg":"Sequence","ts":1647447631115,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[[null]]}
+{"level":"INFO","msg":"Sequence loaded, functions count","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[1]}
+{"level":"DEBUG","msg":"Processing function on index","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[0]}
+{"level":"DEBUG","msg":"Function called","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":[0]}
+{"level":"INFO","msg":"All sequences processed.","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"}}
+{"level":"DEBUG","msg":"Stream type is","ts":1647447631116,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["object"]}
+{"level":"TRACE","msg":"Piping sequence output","ts":1647447631117,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["object"]}
+{"level":"DEBUG","msg":"Content-Type","ts":1647447645282,"from":"Runner","Runner":{"id":"e70222d1-acfc-4e00-b046-4a3a9481c53b"},"data":["application/octet-stream"]}
 ...
-2021-08-09T04:29:39.790Z log (object:Runner) Input message <Buffer 32 30>
-2021-08-09T04:29:40.791Z log (object:Runner) Input message <Buffer 2d 34>
-2021-08-09T04:29:41.792Z log (object:Runner) Input message <Buffer 33 33>
-2021-08-09T04:29:42.798Z log (object:Runner) Input message <Buffer 2d 34 35>
-2021-08-09T04:29:43.801Z log (object:Runner) Input message <Buffer 2d 33 36>
-...
+```
+
+</details>
+
+<details>
+<summary>
+    <strong>5. Get the Instance output</strong>
+</summary>
+
+Once `hello-snowman` Sequence is up and running, we have also sent some input data to the Instance to consume. To see what the program does to this data use the command below, it will show you the Instance output after data transformation. Open one more terminal and paste:
+
+```bash
+si inst output e70222d1-acfc-4e00-b046-4a3a9481c53b
+```
+
+or by using alias
+
+```bash
+si inst output -
+```
+
+This is an example output that you should get:
+
+```bash
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
+Snowman ⛄ is melting! 🥵
+Snowman ⛄ is freezing 🥶 Winter is coming ❄️ ❄️ ❄️ ❄️ ❄️
 ```
 
 </details><br>
 
-> 🎉 Congratulations! 🥳 You have run your first Scramjet Transform Hub Sequence!
+🎉 Congratulations! 🥳 You have run your first Scramjet Transform Hub Sequence!
+
+> To see more Sequence or Instance CLI commands use `si help` accordingly:
+>
+>* `si seq help`
+>
+>* `si inst help`
 
 ## **4. Where to go next**
 

dictionary.md

@@ -261,7 +261,7 @@ Software Development Kit. A collection of tools and libraries to create a softwa
 
 ### Sequence
 
-It is a compressed package (`*.tar.gz`) containing file with a manifest(eg. `package.json`), describing the app and its configuration (such as main file to run); and a **main file** (eg. `index.js`, `app.ts`) that contains a developer's code that consists of chained functions with a lightweight application business logic . Minimal sequence consists of 1 [function](#function).
+It is a package (application) containing a set of files. A file with a manifest(eg. `package.json`), describing the app and its configuration (such as main file to run); and a __main file__ (eg. `index.js`, `app.ts`) that contains a developer's code that consists of chained functions with a lightweight application business logic. Minimal Sequence consists of 1 [function](#function).
 
 ### Socket
 
@@ -277,9 +277,7 @@ standard input/standard output. Application communication channels with the outs
 
 ### STH <!--TODO-->
 
-### Supervisor
-
-An application supervising work of a single [instance](#instance). Communicates with [host](#host), returns health status of the sequence, runner, etc
+shortcut for Scramjet Transform Hub
 
 ### Synchronous
 

samples/README.md

@@ -1,6 +1,6 @@
 # Samples
 
-We have prepared some samples for you. We differentiated them according to the language in which they were written.
+Try out our samples prepared some samples for you. We differentiated them according to the language in which they were written.
 
 > 💡 **Please note that samples below require some previous installations before you start running them. Instructions are [here](../README.md#3-install-scramjet-transform-hub).**
 

templates/README.md

@@ -9,7 +9,7 @@ You can use it as a base for your own samples 👉 [sample template](https://git
 
 In the following sections we will describe both templates' contents and show you how they can be used in your own project.
 
-## Work with JavaScript (Node.js) 
+## Work with JavaScript (Node.js)
 
 This application package template contains two files: