mcupak / beacon-cli Goto Github PK

Implement a CLI talking to the Beacon 0.3 API. The goal here is to create a jar file, which can be included as a dependency in your project and utilized to execute queries against the Beacon API.

Links:

• Beacon spec

Requirements:

• The client should not be interactive, for easy automation. In other words, a single execution of the client should perform a single operation and exit, with all the necessary parameters passed as arguments.
• Consistent API cleanly mapped to the REST API, e.g. cli query --referenceName 1 ....
• Prefer arguments over configuration through static files (e.g. properties files). The host should be configurable as well.
• Use a library for argument parsing (e.g. JCommander or Args4j).
• CLI should be runnable both as a self-contained jar file incl. all its dependencies and via Maven exec plugin.
• Provide responses in JSON.
• Java client library should be used (mcupak/beacon-client#1).
• Standard Unix conventions for return values (error indication) should be used.
• Proper help should be included (global as well as per-operation, if needed).
• Unit tests.
• Documentation (at least README.md).