Skip to content

Commit 5fa52db

Browse files
authored
mention piping a file to the CLI's STDIN
1 parent 385a80e commit 5fa52db

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ $> ./codedx-client https://localhost/codedx --api-key 8e218b38-fcdd-453d-8f78-18
2222
codedx>
2323
```
2424

25+
The program reads input from `STDIN`, so you can pipe the contents of a file to it, to run several commands in sequence.
26+
Each line of the file will be interpreted as a command.
27+
When using this mode, you may wish to provide the `--no-prompt` flag to prevent the program from writing stuff like "codedx>" to `STDOUT`.
28+
29+
```text
30+
$> ./codedx-client https://localhost/codedx --api-key 8e218b38-fcdd-453d-8f78-185f7d1d9fa7 --no-prompt < ./my-commands.txt
31+
```
32+
2533
Once in the REPL, type `help` (and hit Enter) for a list of commands.
2634
You can exit the REPL by typing `exit` or `quit`, or with <kbd>Ctrl+C</kbd> or sending an EOF signal.
2735
You can learn more about a command by typing `help <command name>` e.g. `help analyze`.

0 commit comments

Comments
 (0)