w3up-cli icon indicating copy to clipboard operation
w3up-cli copied to clipboard

Refine naming of commands in CLI

Open JeffLowe opened this issue 3 years ago • 5 comments

Refine the names of the cli commands. Some were called out in meetings on week of 8.15

  • [x] https://github.com/web3-storage/w3up-client/issues/3

Also, update some labels, like:

  • [ ] add user-friendly labels for the “agent” DID versus the “account” DID

JeffLowe avatar Aug 22 '22 18:08 JeffLowe

@jchris do you have specific examples of items we need to update?

JeffLowe avatar Aug 29 '22 15:08 JeffLowe

This is a placeholder for applying feedback from users. I expect there will also be a global refinement (across services) as we work through how to modularize CLI and SDK components.

Currently the only thing I have is -- we should discuss renaming w3up upload to w3up add or w3up put.

This is probably more an SDK API question than a CLI question. Terms suggest their own logic: add / remove go well together, so do put / get / delete

Tagging @mikeal @gobengo for Nouns and Verbs

jchris avatar Aug 29 '22 16:08 jchris

@jchris in the short term I will add aliases. For instance, we use this now. eg. remove and unlink do the same thing.

I'm going to alias add, upload, up and link and put for this action. : https://github.com/nftstorage/w3up-cli/issues/57

the-simian avatar Aug 29 '22 18:08 the-simian

I think that's good for alpha, we can retag this beta so we don't forget to revisit before beta release.

jchris avatar Aug 29 '22 19:08 jchris

linking this command rename request to this ticket https://github.com/web3-storage/w3up-client/issues/3

JeffLowe avatar Sep 07 '22 17:09 JeffLowe