Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Beacon Network CLI #1

Closed
mcupak opened this issue Apr 26, 2016 · 0 comments
Closed

Create Beacon Network CLI #1

mcupak opened this issue Apr 26, 2016 · 0 comments
Assignees

Comments

@mcupak
Copy link
Owner

mcupak commented Apr 26, 2016

Implement a CLI talking to the Beacon Network API.

Links:

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 beacons list --beacon test.
  • Prefer arguments over configuration through static files (e.g. properties files). The host should be configurable as well and default to https://beacon-network.org/api/.
  • 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.
  • Beacon Network provides JSON and XML APIs. The client should utilize the JSON API and provide results in JSON.
  • Java client library should be used (Create Java API library beacon-network-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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants