|
| 1 | +# Delphi Command-Line Interface (CLI) |
| 2 | + |
| 3 | +The command-line interface for the Delphi platform. |
| 4 | + |
| 5 | +We are currently in pre-alpha state! There is no release and the code in |
| 6 | +this repository is purely experimental! |
| 7 | + |
| 8 | +|branch | status | codacy | |
| 9 | +| :---: | :---: | :---: | |
| 10 | +| master | <img src="https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=master"> | [](https://www.codacy.com/app/bhermann/delphi-cli?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-cli&utm_campaign=Badge_Grade)| |
| 11 | +| develop | <img src="https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=develop"> | | |
| 12 | + |
| 13 | +## What is the Delphi Command-Line Interface? |
| 14 | + |
| 15 | +The Delphi CLI is a tool to access the data on the Delphi platform. |
| 16 | +It enables you to search for items matching a query or to inspect a dataset for an item in detail. |
| 17 | +It can be used in an automated context to automatically construct fitting item sets. |
| 18 | + |
| 19 | +## How does it work? |
| 20 | + |
| 21 | +The Delphi CLI checks the provided query and passes it on to the web API of the configured platform. |
| 22 | +The results are printed to the console by default. |
| 23 | + |
| 24 | +## How can I use it? |
| 25 | + |
| 26 | +The Delphi CLI is running on the Java Virtual Machine. |
| 27 | +We require a Java Runtime Environment (JRE) in version 8 or newer. |
| 28 | + |
| 29 | +Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases). |
| 30 | + |
| 31 | +``` |
| 32 | +$ delphi-cli --help |
| 33 | +Delphi Command Line Tool (1.0.0-SNAPSHOT) |
| 34 | +Usage: delphi-cli [test|search|retrieve] [options] |
| 35 | +
|
| 36 | + --version Prints the version of the command line tool. |
| 37 | + --help Prints this help text. |
| 38 | + --server <value> The url to the Delphi server |
| 39 | +``` |
| 40 | +By default the command-line tool uses the official Delphi server at https://delphi.cs.uni-paderborn.de to process queries. |
| 41 | +You can override this setting using the `--server` option or by setting the `DELPHI_SERVER` environment variable. |
| 42 | + |
| 43 | +## Community |
| 44 | + |
| 45 | +Feel welcome to join our chatroom on Gitter: [](https://gitter.im/delphi-hub/delphi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 46 | + |
| 47 | + |
| 48 | +## Contributing |
| 49 | + |
| 50 | +Contributions are *very* welcome! |
| 51 | + |
| 52 | +Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 53 | + |
| 54 | +Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow. |
| 55 | +We use Pull Requests to collect contributions. Especially look out for "help wanted" issues |
| 56 | +[](https://github.com/delphi-hub/delphi-cli/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22), |
| 57 | +but feel free to work on other issues as well. |
| 58 | +You can ask for clarification in the issues directly, or use our Gitter |
| 59 | +chat for a more interactive experience. |
| 60 | + |
| 61 | +[](https://github.com/delphi-hub/delphi-cli/issues) |
| 62 | + |
| 63 | + |
| 64 | +## License |
| 65 | + |
| 66 | +The Delphi CLI is open source and available under Apache 2 License. |
| 67 | + |
| 68 | +[](https://github.com/delphi-hub/delphi-cli/blob/master/LICENSE) |
0 commit comments