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

Basic CLI help text #43

Closed
Munchotaur opened this issue Dec 16, 2024 · 2 comments · May be fixed by #84
Closed

Basic CLI help text #43

Munchotaur opened this issue Dec 16, 2024 · 2 comments · May be fixed by #84
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Munchotaur
Copy link

As it stands, markitdown installs and works just fine via pipx.

However running it as a command line app with -h or --help throws an UnsupportedFormatException. Not that much help text is needed but it would be better than an error.

@gagb gagb added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 16, 2024
@kevinclb
Copy link
Contributor

I made a pull request to address this issue as my first contribution to this project.

#46

Let me know if you have any suggestions or comments.

@gagb

@ArunSunhare
Copy link

Issue Title: Improve Basic CLI Help Text for markitdown
Description:
The markitdown tool installs and runs successfully when installed via pipx. However, when executing the command with --help or without any arguments, the output is unclear or does not provide sufficient guidance to new users.

Steps to Reproduce:
Install markitdown via pipx:
bash
Copy code
pipx install markitdown
Run the command without arguments:
bash
Copy code
markitdown
Alternatively, run the help command:
bash
Copy code
markitdown --help
Observed Behavior:
The output is either unclear, incomplete, or missing critical information about the tool's usage.
Expected Behavior:
The help text should clearly describe:
What the tool does.
How to use it (e.g., syntax and examples).
List of available commands and options.
Proposed Solution:
Update the CLI help text to provide:
A brief description of the tool.
A usage guide, including the command structure.
Examples of common use cases.
Example Help Text:

bash
Copy code
markitdown: A CLI tool for converting markdown files to HTML.

Usage:
markitdown [OPTIONS] <input_file.md> [output_file.html]

Options:
--help Show this help message and exit.
--version Display the current version of markitdown.

Examples:
markitdown input.md output.html
markitdown input.md

Additional Notes:
Contributors may need to explore the CLI parsing library used (e.g., argparse, click, etc.) to make the necessary improvements.
Ensure the updated help text aligns with any additional features or options provided by markitdown.

@casperdcl casperdcl mentioned this issue Dec 17, 2024
@gagb gagb closed this as completed Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants