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

A way to list all the commands in the file #26

Closed
damccull opened this issue Feb 22, 2022 · 5 comments
Closed

A way to list all the commands in the file #26

damccull opened this issue Feb 22, 2022 · 5 comments
Labels
enhancement New feature or request triage This issue needs to be examined by a maintainer

Comments

@damccull
Copy link

Description
Please add a reserved command, or maybe a switch, to list all the commands bonnie knows about in the folder where the toml resides. Something like bonnie ls, bonnie list, or bonnie --list.

Reasoning
Bonnie is awesome but, unless I'm mistaken, you must open the toml file to see what commands exist, and there's no quick reference. You have to read through it all and, in some cases, parse the bonnie structure to figure out what works.

Are you willing to work on an implementation of this?
I am not confident enough in my rust skills yet to dissect someone else's code and add such a command. If I get to that point, I will be happy to send a PR, but in the meantime, I am placing my hopes in someone else who has such skill and recognizes this as a good feature to add. If not, I suppose I will live without it for the time being. Thank you!

@damccull damccull added enhancement New feature or request triage This issue needs to be examined by a maintainer labels Feb 22, 2022
@arctic-hen7
Copy link
Owner

This already exists with bonnie help. You can provide descriptions of commands with the .desc property, but that command will list all user-provided commands. Does that satisfy your use-case?

@damccull
Copy link
Author

Wow, yep, that does it. I didn't try bonnie help because most rust commands use only the command --help structure and don't respond to just help at all or use it as an argument for something else that will break things. This works fine, thanks.

@damccull damccull reopened this Feb 23, 2022
@damccull
Copy link
Author

Would it be a good or bad idea to alias bonnie help to just bonnie? I certainly would have discovered it easier. Or, at least include a message pointing users at bonnie help if they just type bonnie. Something like "Please provide a command to run. Type bonnie help for a list of commands."

@arctic-hen7
Copy link
Owner

I'm pretty sure it's under bonnie -h, but it may not be...

I'm certainly willing to add a message pointing users to it when they run bonnie though, that's a great idea!

@damccull
Copy link
Author

I'll take it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage This issue needs to be examined by a maintainer
Projects
None yet
Development

No branches or pull requests

2 participants