Skip to content

Commit 9f7b01c

Browse files
authored
Update README.md
1 parent dbb0901 commit 9f7b01c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,18 @@ It can be used in an automated context to automatically construct fitting item s
2121
The Delphi CLI checks the provided query and passes it on to the web API of the configured platform.
2222
The results are printed to the console by default.
2323

24+
## How do I run Delphi CLI?
25+
26+
```
27+
$ git clone https://github.com/delphi-hub/delphi-cli.git
28+
$ cd delphi-cli/
29+
$ sbt stage
30+
$ cd target/universal/stage/bin
31+
$ ./delphi [command] [options]
32+
```
33+
34+
For the different commands and options, see [How can I use it?](#how-can-i-use-it)
35+
2436
## How can I use it?
2537

2638
The Delphi CLI is running on the Java Virtual Machine.
@@ -29,9 +41,9 @@ We require a Java Runtime Environment (JRE) in version 8 or newer.
2941
Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases).
3042

3143
```
32-
$ delphi-cli --help
44+
$ delphi --help
3345
Delphi Command Line Tool (1.0.0-SNAPSHOT)
34-
Usage: delphi-cli [test|retrieve|search] [options] <args>...
46+
Usage: delphi [test|retrieve|search] [options] <args>...
3547
3648
--version Prints the version of the command line tool.
3749
--help Prints this help text.

0 commit comments

Comments
 (0)