whipper
whipper copied to clipboard
whipper-team
Refactoring of the command syntax
As mentioned in https://github.com/JoeLametta/whipper/issues/254 and more specifically in https://github.com/JoeLametta/whipper/issues/21#issuecomment-225448572 the current command line syntax could be improved.
To take up the suggestions I would like to propose the following changes
| Old | New |
|---|---|
| whipper offset find whipper drive analyze |
whipper setup /dev/sdX |
| whipper cd rip | whipper rip /dev/sdX |
| whipper cd info | whipper info /dev/sdX |
On single drive systems the /dev/sdX part would be optional. whipper setup would combine both whipper offset find and whipper drive analyze as both commands are only issued once per drive anyways (most of the times at least).
There's a pretty good rework someone in IRC posted a while back as a gist, hopefully I can find it again. I like the idea of offset find and drive analyze falling under one command (with the option to say whipper setup --offset or --analyze/--defeat or something, if you need to run just one portion).
For me, that also seems like a good opportunity to improve the usability of whipper. Should we keep the backwards compatibility? I think that would make the code pretty messy but could be useful for keeping some scripts (that are propably out there) compatible.
I don't think backwards compatability is much of a concern. We're not providing an ABI or even a stable API, just top level commands that are ideally supposed to be as user friendly as possible.
We're not even at a stable 1.0 release (nor would I think that would be very good reason to keep backwards compatability either on its own), so I think it's appropriate to make large changes at this stage.
Well, I still think the syntax of whipper is quite odd so it'd be nice to see this being kept in the backlog. Maybe with a lower priority.