Extra tweaks to CLI #72
Conversation
Refactored the structure of the options to be a bit more modular: * Moved '--quiet' flag to top of options * Added extra flag to specificy literal reading of files, or only the first line. * Drop whitespace around hash/password if only first line of a file is read * Added lots of 'help' text to give more info when using '--help' * Added '--version' option * Add newline after outputting hash when using stdin interactively
|
Thanks, I'll try to take a look at this in the next couple of days. Maybe @blackheaven would want to review this as well? |
IIUC, it's the easiest way to make it available to everyone ( |
|
@blackheaven Do you know of other executables on hackage that only have an |
…ng for backwards compatibility
I think this is generally a (widely-held) misconception. Hackage is for distributing both libraries and standalone executables. Like @blackheaven said, there are a few Linux distros that have automation around packaging/distributing Haskell packages from Hackage. But Haskell packages that aren't on Hackage don't benefit from this automation. As far as I know, Nixpkgs and OpenSUSE both fall into this category. |
password-cli/README.md
Outdated
| ``` | ||
| user@computer $ cat password.txt | password-cli hash pbkdf2 | ||
| Enter password: | ||
| sha512:25000:8ZJ1T55Y0sPRwltXNe/2fA==:aA0BT1WlTg+t2pSr8E6+l2zJW88rmUiDlKeohSOnzS0nLOumDSyK0FfsiNJBvWvWVkB2r6IMxRqelk4LZR33ow==user@computer $ | ||
| ``` |
There was a problem hiding this comment.
| ``` | |
| user@computer $ cat password.txt | password-cli hash pbkdf2 | |
| Enter password: | |
| sha512:25000:8ZJ1T55Y0sPRwltXNe/2fA==:aA0BT1WlTg+t2pSr8E6+l2zJW88rmUiDlKeohSOnzS0nLOumDSyK0FfsiNJBvWvWVkB2r6IMxRqelk4LZR33ow==user@computer $ | |
| ``` | |
| ```console | |
| $ cat password.txt | password-cli hash pbkdf2 | |
| Enter password: | |
| sha512:25000:8ZJ1T55Y0sPRwltXNe/2fA==:aA0BT1WlTg+t2pSr8E6+l2zJW88rmUiDlKeohSOnzS0nLOumDSyK0FfsiNJBvWvWVkB2r6IMxRqelk4LZR33ow== | |
| ``` |
I'd just remove the user@computer $ at the end of the line here, since you explain it in the next paragraph.
Although I see why you originally wrote it like this. It may be easier to understand as you have it in this current PR.
There was a problem hiding this comment.
Yeah, but without the user@computer it's difficult to convey it obviously.
I removed it and hope it's obvious from the text and any testing people would do with the CLI.
…ke 'user@computer' prefixes
|
I was wondering what the highlight code for |
Added a bunch of documentation, help strings and restructured the internals a bit.
@cdepillabout Take your time reviewing this. There's no rush.
Also, I'm wondering if it's even necessary to publish
password-clito hackage.com 🤔It's only an executable, and hackage is for libraries. It being in the repo is good enough for anyone who'd like to build it, right?
Should we maybe add the fact that there IS a CLI to the
password/READMEand link to the repo in there?(When we're happy with the state of the CLI, of course)