Open noahra opened 7 months ago
Pandoc can be used to generate a text file (for the --help) and a man page (for man
) from a Markdown file. It may be useful to execute man
if it's available on the system (and if byteblitz's manual page is found), since it allows scrolling, searching, etc.
Currently, byteblitz lacks a built-in helper manual or usage guide accessible from the command line. This feature is essential for new users or even experienced users who need a quick reference to the tool's functionalities and command syntax. Implementing a -h or --help option would greatly enhance user experience and accessibility.
Feature Request:
I propose adding a -h or --help option to byteblitz. This option should display a concise yet comprehensive guide on how to use byteblitz, including:
A brief description of what byteblitz does. A list of all available commands and their functionalities. Examples of common usage scenarios. Information about other available flags and options (e.g., format switching).
Expected Outcome:
Users can type
byteblitz -h
orbyteblitz --help
to access the help manual. The manual provides clear, useful information that enhances the user experience. Improved accessibility and ease of use, particularly for new users. Additional Considerations:The help manual should be easy to read and well-formatted for command-line display. It should be kept up-to-date with the latest features and changes in byteblitz.