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

Rework command line interface #69

Closed
lorc opened this issue Apr 17, 2024 · 1 comment · Fixed by #74
Closed

Rework command line interface #69

lorc opened this issue Apr 17, 2024 · 1 comment · Fixed by #74

Comments

@lorc
Copy link
Collaborator

lorc commented Apr 17, 2024

Current xu command line interface is clunky. For example, for some reason we use flags for mandatory options, which is defiles established practices. Moreover flags are locked in positions. For example #57 introduces new -c flag for xu create command, but you can't use change order of flags. Only this command is possible:

# xu create -d <domid> -c <config_name>

You can't even swap the arguments:

# xu create -c <config_name> -d <domid>  # this will not work

I propose to align use of flags with established standard: only optional parameters needs flag, all mandatory options are positional and require no additional flags. For example:

# xu console 1
# xu create domd -d 1
# xu create domd
# xu destroy 1

This is a great time for this, before we release the fist "stable" version.

@lorc lorc added this to the First "stable" release milestone Apr 17, 2024
@GrygiriiS
Copy link

Before reworking cmd interface it shell be documented. Or documentation shell be created for the new one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants