Skip to content

Commit 639314b

Browse files
d-biehld-biehl
committed
docs: update some docs
1 parent 2f356d5 commit 639314b

File tree

2 files changed

+154
-28
lines changed
  • docs/03_reference
  • packages/repl_server/src/robotcode/repl_server

2 files changed

+154
-28
lines changed

‎docs/03_reference/cli.md

Lines changed: 153 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,10 @@ robotcode [OPTIONS] COMMAND [ARGS]...
215215

216216
Run Robot Framework interactively.
217217

218+
- [`repl-server`](#repl-server)
219+
220+
Start a REPL server, client can connect to the server and run the REPL scripts.
221+
218222
- [`robot`](#robot)
219223

220224
Runs `robot` with the selected configuration, profiles, options and arguments.
@@ -273,11 +277,10 @@ provided, the current directory is analyzed by default.
273277

274278
The return code is a bitwise combination of the following values:
275279

276-
- `0`: **SUCCESS** - No issues detected.
277-
- `1`: **ERRORS** - Critical issues found.
278-
- `2`: **WARNINGS** - Non-critical issues detected.
279-
- `4`: **INFORMATIONS** - General information messages.
280-
- `8`: **HINTS** - Suggestions or improvements.
280+
- `0`: **SUCCESS** - No issues detected. - `1`: **ERRORS** - Critical issues
281+
found. - `2`: **WARNINGS** - Non-critical issues detected. - `4`:
282+
**INFORMATIONS** - General information messages. - `8`: **HINTS** -
283+
Suggestions or improvements.
281284

282285
*Examples*:
283286
```
@@ -303,7 +306,7 @@ robotcode analyze code [OPTIONS] [PATHS]...
303306

304307
- `-f, --filter PATTERN *`
305308

306-
Glob pattern to filter files to analyze. Can be specified multiple times.
309+
Glob pattern to filter files to analyze. Can be specified multiple times.
307310

308311

309312
- `-v, --variable name:value *`
@@ -653,17 +656,17 @@ robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
653656

654657
- `--tcp [<ADDRESS>:]<PORT>`
655658

656-
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, port, mode.
659+
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, mode, port.
657660

658661

659662
- `--pipe-server NAME`
660663

661-
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, mode, bind, tcp.
664+
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: port, tcp, bind, pipe-name, mode.
662665

663666

664-
- `--mode [tcp|pipe-server]`
667+
- `--mode [pipe-server|tcp]`
665668

666-
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: tcp, pipe-server. [env var: ROBOTCODE_MODE; default: tcp]
669+
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: pipe-server, tcp. [env var: ROBOTCODE_MODE; default: tcp]
667670

668671

669672
- `--port PORT`
@@ -678,7 +681,7 @@ robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
678681

679682
- `--pipe-name NAME`
680683

681-
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: tcp, pipe-server, port, bind. [env var: ROBOTCODE_PIPE_NAME]
684+
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: pipe-server, tcp, bind, port. [env var: ROBOTCODE_PIPE_NAME]
682685

683686

684687
- `--version`
@@ -705,47 +708,47 @@ robotcode debug-launch [OPTIONS]
705708
**Options:**
706709
- `--stdio`
707710

708-
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, pipe-server, mode, bind, tcp, pipe. [env var: ROBOTCODE_STDIO]
711+
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: socket, port, pipe, pipe-server, tcp, bind, pipe-name, mode. [env var: ROBOTCODE_STDIO]
709712

710713

711714
- `--tcp [<ADDRESS>:]<PORT>`
712715

713-
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, pipe-server, mode, stdio, pipe.
716+
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, pipe-server, pipe-name, mode.
714717

715718

716719
- `--socket [<ADDRESS>:]<PORT>`
717720

718-
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, pipe-server, mode, tcp, stdio, pipe.
721+
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, port, pipe, pipe-server, tcp, pipe-name, mode.
719722

720723

721724
- `--pipe NAME`
722725

723-
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, pipe-server, mode, bind, tcp, stdio.
726+
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe-server, tcp, bind, pipe-name, mode.
724727

725728

726729
- `--pipe-server NAME`
727730

728-
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, mode, bind, tcp, stdio, pipe.
731+
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, tcp, bind, pipe-name, mode.
729732

730733

731734
- `--mode [stdio|tcp|socket|pipe|pipe-server]`
732735

733-
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: socket, pipe-server, tcp, stdio, pipe. [env var: ROBOTCODE_MODE; default: stdio]
736+
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: stdio, socket, pipe, pipe-server, tcp. [env var: ROBOTCODE_MODE; default: stdio]
734737

735738

736739
- `--port PORT`
737740

738-
The port to listen on or connect to. (Only valid for `tcp` and `socket mode`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe, pipe-name. [env var: ROBOTCODE_PORT; default: 6611; 1<=x<=65535]
741+
The port to listen on or connect to. (Only valid for `tcp` and `socket mode`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_PORT; default: 6611; 1<=x<=65535]
739742

740743

741744
- `--bind ADDRESS *`
742745

743-
Specify alternate bind address. If no address is specified `localhost` is used. (Only valid for tcp and socket mode) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe, pipe-name. [env var: ROBOTCODE_BIND; default: 127.0.0.1]
746+
Specify alternate bind address. If no address is specified `localhost` is used. (Only valid for tcp and socket mode) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_BIND; default: 127.0.0.1]
744747

745748

746749
- `--pipe-name NAME`
747750

748-
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: port, socket, pipe-server, bind, tcp, stdio, pipe. [env var: ROBOTCODE_PIPE_NAME]
751+
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, pipe-server, tcp, bind. [env var: ROBOTCODE_PIPE_NAME]
749752

750753

751754
- `--version`
@@ -1175,27 +1178,27 @@ robotcode language-server [OPTIONS] [PATHS]...
11751178
**Options:**
11761179
- `--stdio`
11771180

1178-
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, mode, bind, tcp, pipe. [env var: ROBOTCODE_STDIO]
1181+
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: socket, port, pipe, tcp, bind, pipe-name, mode. [env var: ROBOTCODE_STDIO]
11791182

11801183

11811184
- `--tcp [<ADDRESS>:]<PORT>`
11821185

1183-
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, mode, stdio, pipe.
1186+
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, pipe-name, mode.
11841187

11851188

11861189
- `--socket [<ADDRESS>:]<PORT>`
11871190

1188-
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, mode, tcp, stdio, pipe.
1191+
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, port, pipe, tcp, pipe-name, mode.
11891192

11901193

11911194
- `--pipe NAME`
11921195

1193-
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: pipe-name, port, socket, mode, bind, tcp, stdio.
1196+
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, tcp, bind, pipe-name, mode.
11941197

11951198

1196-
- `--mode [socket|stdio|pipe|tcp]`
1199+
- `--mode [stdio|tcp|socket|pipe]`
11971200

1198-
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: socket, stdio, tcp, pipe. [env var: ROBOTCODE_MODE; default: stdio]
1201+
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: stdio, tcp, socket, pipe. [env var: ROBOTCODE_MODE; default: stdio]
11991202

12001203

12011204
- `--port PORT`
@@ -1210,7 +1213,7 @@ robotcode language-server [OPTIONS] [PATHS]...
12101213

12111214
- `--pipe-name NAME`
12121215

1213-
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: port, socket, bind, tcp, stdio, pipe. [env var: ROBOTCODE_PIPE_NAME]
1216+
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, tcp, bind. [env var: ROBOTCODE_PIPE_NAME]
12141217

12151218

12161219
- `--version`
@@ -1441,6 +1444,129 @@ robotcode repl [OPTIONS] [FILES]...
14411444
xUnit output file. see `robot --xunit` option.
14421445

14431446

1447+
- `-s, --source FILE`
1448+
1449+
Specifies the path to a source file. This file must not exist and will neither be read nor written. It is used solely to set the current working directory for the REPL script and to assign a name to the internal suite.
1450+
1451+
1452+
- `--version`
1453+
1454+
Show the version and exit.
1455+
1456+
1457+
- `--help`
1458+
1459+
Show this message and exit.
1460+
1461+
1462+
#### repl-server
1463+
1464+
Start a REPL server, client can connect to the server and run the REPL
1465+
scripts.
1466+
1467+
1468+
**Usage:**
1469+
```text
1470+
robotcode repl-server [OPTIONS] [FILES]...
1471+
```
1472+
1473+
1474+
**Options:**
1475+
- `--stdio`
1476+
1477+
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: socket, port, pipe, pipe-server, tcp, bind, pipe-name, mode. [env var: ROBOTCODE_STDIO]
1478+
1479+
1480+
- `--tcp [<ADDRESS>:]<PORT>`
1481+
1482+
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, pipe-server, pipe-name, mode.
1483+
1484+
1485+
- `--socket [<ADDRESS>:]<PORT>`
1486+
1487+
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: stdio, port, pipe, pipe-server, tcp, pipe-name, mode.
1488+
1489+
1490+
- `--pipe NAME`
1491+
1492+
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe-server, tcp, bind, pipe-name, mode.
1493+
1494+
1495+
- `--pipe-server NAME`
1496+
1497+
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, tcp, bind, pipe-name, mode.
1498+
1499+
1500+
- `--mode [stdio|tcp|socket|pipe|pipe-server]`
1501+
1502+
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: stdio, socket, pipe, pipe-server, tcp. [env var: ROBOTCODE_MODE; default: stdio]
1503+
1504+
1505+
- `--port PORT`
1506+
1507+
The port to listen on or connect to. (Only valid for `tcp` and `socket mode`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_PORT; default: 6601; 1<=x<=65535]
1508+
1509+
1510+
- `--bind ADDRESS *`
1511+
1512+
Specify alternate bind address. If no address is specified `localhost` is used. (Only valid for tcp and socket mode) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_BIND; default: 127.0.0.1]
1513+
1514+
1515+
- `--pipe-name NAME`
1516+
1517+
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: stdio, socket, port, pipe, pipe-server, tcp, bind. [env var: ROBOTCODE_PIPE_NAME]
1518+
1519+
1520+
- `-v, --variable name:value *`
1521+
1522+
Set variables in the test data. see `robot --variable` option.
1523+
1524+
1525+
- `-V, --variablefile PATH *`
1526+
1527+
Python or YAML file file to read variables from. see `robot --variablefile` option.
1528+
1529+
1530+
- `-P, --pythonpath PATH *`
1531+
1532+
Additional locations where to search test libraries and other extensions when they are imported. see `robot --pythonpath` option.
1533+
1534+
1535+
- `-d, --outputdir DIR`
1536+
1537+
Where to create output files. see `robot --outputdir` option.
1538+
1539+
1540+
- `-o, --output FILE`
1541+
1542+
XML output file. see `robot --output` option.
1543+
1544+
1545+
- `-r, --report FILE`
1546+
1547+
HTML output file. see `robot --report` option.
1548+
1549+
1550+
- `-l, --log FILE`
1551+
1552+
HTML log file. see `robot --log` option.
1553+
1554+
1555+
- `-x, --xunit FILE`
1556+
1557+
xUnit output file. see `robot --xunit` option.
1558+
1559+
1560+
- `--version`
1561+
1562+
Show the version and exit.
1563+
1564+
1565+
- `-s, --source FILE`
1566+
1567+
Specifies the path to a source file. This file must not exist and will neither be read nor written. It is used solely to set the current working directory for the REPL script and to assign a name to the internal suite.
1568+
1569+
14441570
- `--help`
14451571

14461572
Show this message and exit.

‎packages/repl_server/src/robotcode/repl_server/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ def repl_server(
190190
files: Tuple[Path, ...],
191191
) -> None:
192192
"""\
193-
Run Robot Framework interactively.
193+
Start a REPL server, client can connect to the server and run the REPL scripts.
194194
"""
195195

196196
mode, port, bind, pipe_name = resolve_server_options(

0 commit comments

Comments
 (0)