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

CLI naming #12298

Open
devinark opened this issue Jul 8, 2022 · 3 comments
Open

CLI naming #12298

devinark opened this issue Jul 8, 2022 · 3 comments
Assignees
Labels
bug Something isn't working enhancement New feature or request

Comments

@devinark
Copy link

devinark commented Jul 8, 2022

What happened?

I propose renaming chia show to chia node since half the commands are not about showing information but about interacting with the full node.
Or only the commands related to doing actions on the full node could be moved to chia node, while other commands that are about showing information like chia netspace could be moved to a chia show subcommand.

Second thing, the 2 letter short options are a footgun for people used to CLI tools. The UNIX convention is for short options to be only 1 letter long so that they can be combined in one argument, but for example chia show has 3 different options -bh, -b and -h.

This might be low priority but the CLI is often the first point of contact for beginners, so reducing confusion is a good thing. I was personally confused by it.

Version

1.4.0

What platform are you using?

Linux

What ui mode are you using?

CLI

Relevant log output

No response

@devinark devinark added the bug Something isn't working label Jul 8, 2022
@wallentx
Copy link
Contributor

I currently have #10760 awaiting review that might make a little more sense of some of the things you mentioned.

As to the 2 letter short options, @altendky and I agree 😁

@altendky
Copy link
Contributor

So I finally realized an example of a CLI that uses multi-character single-dash (hyphen?) options. find. Still, not common. And I guess technically those are in the 'expression'.

@wallentx wallentx linked a pull request Jul 14, 2022 that will close this issue
@devinark
Copy link
Author

So I finally realized an example of a CLI that uses multi-character single-dash (hyphen?) options. find. Still, not common. And I guess technically those are in the 'expression'.

Aside from the fact that find is quite infamous for its bad interface, it's less confusing as all the parameters are single-dash. The problem with the chia CLI is that at first glance it does look like standard getopts behavior (until you squint and realize some of the short options have 2 letters).

@wallentx wallentx added the enhancement New feature or request label Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants