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

Refine CLI interface semantics #87

Open
EvilBit opened this issue Jul 14, 2021 · 1 comment
Open

Refine CLI interface semantics #87

EvilBit opened this issue Jul 14, 2021 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@EvilBit
Copy link
Contributor

EvilBit commented Jul 14, 2021

Before setting the CLI API in stone for a long time in milestone v1.0, I suggest remodeling the semantics of the sub-commands slightly.

For example:
generate and calculate are semantically not too dissimilar and generate at least some amount of cognitive friction on usage (e.g. generate could just as well refer to generating the TOTP).
I suggest e.g. the following transition:

  • generate -> init (ubiquitous and well understood from modern CLI design)
  • calculate -> attest or simply show

Also refer to the request for a status command in #85.
Great reference on modern and idiomatic CLI design e.g. here, specifically on sub-commands and noun verb vs verb noun ordering here.

This is less of a pressing issue, than an invitation for an open collection of ideas about future CLI design :)

P.S.: I hope, creating a number of issues is not considered rude - it surely isn't intended that way.

@diabonas
Copy link
Member

I like init and show - the latter also matches the naming of the show-tpm2-totp helper that we use internally.

P.S.: I hope, creating a number of issues is not considered rude - it surely isn't intended that way.

Not at all! Using the issue tracker as a place to brainstorm new features and keep track of possible future extensions is perfectly fine, feel free to add here whatever comes to mind :)

@diabonas diabonas added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 15, 2021
@diabonas diabonas added this to the v1.0 milestone Jul 15, 2021
@EvilBit EvilBit mentioned this issue Jul 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants