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 API Redesign #510

Open
TheEadie opened this issue Feb 25, 2023 · 0 comments
Open

CLI API Redesign #510

TheEadie opened this issue Feb 25, 2023 · 0 comments

Comments

@TheEadie
Copy link
Owner

Discovering the options on the CLI is currently difficult as the CLI is arranged verb noun. Since not all verbs apply to all nouns you have to guess which verb you want to use before discovering what objects there are to act on.

Alternative is to use a noun verb scheme.

Local

Root

worms version
worms update
worms patch-game

Config

worms config list
worms config edit
worms config [locate|dir]

Schemes

worms scheme[s] list
worms scheme[s] create <name> --options
worms scheme[s] describe <name>
worms scheme[s] [delete|rm] <name>
worms scheme[s] [locate|dir]

Replays

worms replay[s] list
worms replay[s] process <datetime>
worms replay[s] describe <datetime>
worms replay[s] [delete|rm] <datetime>
worms replay[s] view <datetime>
worms replay[s] [locate|dir]

Gifs

worms gif[s] list
worms gif[s] create <name> --options
worms gif[s] [delete|rm] <name>
worms gif[s] view <name>
worms gif[s] [locate|dir]

Hub

Root

worms auth

Games

worms game[s] list
worms game[s] [host|create]
worms game[s] join

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

No branches or pull requests

1 participant