Skip to content

Commit 3543786

Browse files
committed
Update readme
1 parent 3ed98a4 commit 3543786

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -408,14 +408,23 @@ All text-based commands are transmitted to the platform over the HTTP network pr
408408
a small overhead when the client and server run within the same JVM instance; on the other hand, this approach
409409
allows interaction with different servers.
410410

411+
**Local and Remote Commands.** Any command can be local, remote, or both. Local commands can be executed without a
412+
session, while remote commands require an active session.
413+
411414
**Command Executor**. The execution of commands is handled by `CommandExecutor`, which receives a `String` containing
412415
the commands as input. Each command is a separate class implementing the `Command` interface. The executor splits the
413416
text into individual commands and processes each one.
414417

415-
The execution flow is as follows:
418+
The execution flow of a local command is as follows:
419+
420+
```
421+
Console ⮂ Command Executor ⮂ Command ⮂ Framework API
422+
```
423+
424+
The execution flow of a remote command is as follows:
416425

417426
```
418-
Console Command Executor Client Server EndpointHandler Framework API
427+
Console Command Executor ⮂ Command ⮂ Client Server EndpointHandler Framework API
419428
```
420429

421430
**Custom Command**. To create a custom command, you need to do the following:
@@ -432,9 +441,6 @@ To create a custom `EndpointHandler`, do the following:
432441
**Command Scripts**. A command `String` can contain an unlimited number of commands separated by `;`. This allows for
433442
the use of command scripts — files that contain text commands. Typically, scripts are stored in the `script` folder.
434443

435-
**Local and Remote Commands.** Any command can be local, remote, or both. Local commands can be executed without a
436-
session, while remote commands require an active session.
437-
438444
**Special Symbols**. When working with commands, the following special characters should be considered:
439445

440446
* `;` — used to separate commands.
@@ -445,7 +451,7 @@ session, while remote commands require an active session.
445451

446452
```
447453
# to open a session to the server
448-
session:open demo -a 127.0.0.1:7900 -n admin -p admin
454+
session:open demo -a 127.0.0.1:1200 -n admin -p admin
449455
450456
# to list all remote commands
451457
command:list

0 commit comments

Comments
 (0)