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

Update CLI documentation #175

Open
Miles-Garnsey opened this issue Nov 25, 2020 · 0 comments
Open

Update CLI documentation #175

Miles-Garnsey opened this issue Nov 25, 2020 · 0 comments
Assignees

Comments

@Miles-Garnsey
Copy link
Collaborator

##Summary

The current CLI documentation at the home page needs some love.

Currently, using options such as --region='us-west-2' will yield an exception:

Exception in thread "main" com.beust.jcommander.ParameterException: There should be exactly 3 main parameters but 5 were found

The CLI help text itself remains correct, as it is generated via the jcommander configurations.

Proposed changes

The offending text comes from a file manual/src/includes/help.txt which seems to not be regenerated at build. I suggest adding a Gradle build task which pipes the relevant help output into this file when the project is built.

Within the help build files, this will induce a dependancy on a full build of the project.

@Miles-Garnsey Miles-Garnsey self-assigned this Nov 25, 2020
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

1 participant