search

getodk / briefcase

ODK Briefcase is a Java application for fetching and pushing forms and their contents. It helps make billions of data points from ODK portable. Contribute and make the world a better place! ✨💼✨
https://docs.getodk.org/briefcase-intro
Other
60 stars 156 forks source link

List all operations in CLI help #450

Closed EdRW closed 6 years ago

EdRW commented 6 years ago

Software versions

Briefcase v1.10.0

Problem description

The command line help provides a list of general arguments but does not list the operations in which those arguments can be used. The only way I know of to view the listing of available CLI operations and their arguments is to attempt to call an already known CLI operation with missing parameters.

Steps to reproduce the problem

  1. Use the following command at CLI: java -jar ODK-Briefcase-v1.10.0-beta.0.jar help
  2. Use the following command at CLI: java -jar ODK-Briefcase-v1.10.0-beta.0.jar -psha

Expected behavior

Using the following command at CLI: java -jar ODK-Briefcase-v1.10.0-beta.0.jar help should display information about the list of operations available at the command line.

Other information

java -jar ODK-Briefcase-v1.10.0-beta.0.jar help image

java -jar ODK-Briefcase-v1.10.0-beta.0.jar -psha image

ggalmazor commented 6 years ago

Hi, @xNeophyte! Thanks for reporting this issue. The help message from your first screenshot belongs to the “old” legacy mode and the second to the new cli interface.

To get the new help message, which shows the operation list and their arguments in a more detailed fashion, you can execute Briefcase with the -h flag.

We are working to make the cli interface more coherent and user-friendly. #441 will help us to unify the help message in the legacy mode and show some useful warning messages.

yanokwa commented 6 years ago

Closed by #441