README.md

Delphi Command-Line Interface (CLI)

The command-line interface for the Delphi platform.

We are currently in pre-alpha state! There is no release and the code in this repository is purely experimental!

branch	status	codacy	coverage	snyk
master
develop

What is the Delphi Command-Line Interface?

The Delphi CLI is a tool to access the data on the Delphi platform. It enables you to search for items matching a query or to inspect a dataset for an item in detail. It can be used in an automated context to automatically construct fitting item sets.

How does it work?

The Delphi CLI checks the provided query and passes it on to the web API of the configured platform. The results are printed to the console by default.

How do I run Delphi CLI?

$ git clone https://github.com/delphi-hub/delphi-cli.git
$ cd delphi-cli/
$ sbt stage
$ cd target/universal/stage/bin
$ ./delphi [command] [options]

For the different commands and options, see How can I use it?

How can I use it?

The Delphi CLI is running on the Java Virtual Machine. We require a Java Runtime Environment (JRE) in version 8 or newer.

Our software is available as a binary release on GitHub.

$ delphi --help
Delphi Command Line Tool (0.9.5-SNAPSHOT)
Usage: delphi-cli [test|features|retrieve|search] [options] <args>...

  --version                Prints the version of the command line tool.
  --help                   Prints this help text.
  --server <value>         The url to the Delphi server
  --raw                    Output the raw results
  --silent                 Suppress non-result output

By default the command-line tool uses the official Delphi server at https://delphi.cs.uni-paderborn.de to process queries. You can override this setting using the --server option or by setting the DELPHI_SERVER environment variable.

Community

Feel welcome to join our chatroom on Gitter:

Contributing

Contributions are very welcome!

Before contributing, please read our Code of Conduct.

Refer to the Contribution Guide for details about the workflow. We use Pull Requests to collect contributions. Especially look out for "help wanted" issues , but feel free to work on other issues as well. You can ask for clarification in the issues directly, or use our Gitter chat for a more interactive experience.

License

The Delphi CLI is open source and available under Apache 2 License.