This will become a single-page reference on the jobq CLI, its capabilities, and further information on flags and their related use cases.
Currently, only the submit command is documented.
Putting this up for a quick first impression now. Presenting the CLI as such means that there will be some churn whenever we update options and/or commands, but I'm currently not sure how to best address this.
Also, please let me know if you would like to see a switch "encyclopedia", i.e. a quick explanation for most / all switches either in written text or in the argparse help.
(I'm personally a fan of how git help does this. Maybe we could even show our documentation in a similar command, but for now, it's probably enough to quickly introduce each command, its uses , and capabilities.)
This will become a single-page reference on the jobq CLI, its capabilities, and further information on flags and their related use cases.
Currently, only the submit command is documented.
Putting this up for a quick first impression now. Presenting the CLI as such means that there will be some churn whenever we update options and/or commands, but I'm currently not sure how to best address this.
Also, please let me know if you would like to see a switch "encyclopedia", i.e. a quick explanation for most / all switches either in written text or in the argparse help.
(I'm personally a fan of how git help does this. Maybe we could even show our documentation in a similar command, but for now, it's probably enough to quickly introduce each command, its uses , and capabilities.)