Improve docs on cli usage
Halkcyon opened this issue · 5 comments
Logically you can figure out some of the items are different parameter sets, but the docs don't make that clear.
What does cover mean here, the key/password? I think it may be clearer to change the name. Does it work to pass a file and a secret? Probably not. Are outputs on stdout or is it mandatory to specify output?
hide [options] [secret] [cover]
-f, --file <file> Extract input from file
-n, --nocrypt If you don't need encryption (default: false)
-i, --integrity If additional security of preventing tampering is needed (default: false)
-o, --output <output> Stream the results to an output file
-h, --help display help for command
Similar questions here, where do you pass [cover] here to decrypt the string? Options aren't stated in the same format as the previous example.
reveal [data]
-f, --file <file> Extract input from file
-cp, --clip Copy Data directly from clipboard
-o, --output <output> Stream the secret to an output file
-h, --help display help for command
@mohanpierce99 common to you, but we're not all studying crypto nor have we 🙂
Interactive is great - but what if I wanted to script/automate this and build my own tools? I know I can use the API, but that locks me into using node scripts versus system scripting languages.
This is a really cool project, just leaving feedback that would make me want to adopt using it regularly.
@mohanpierce99 we should try adding a --config flag to pass all the config as a command-line argument. For regular usage it wouldn't be ideal to use it because you'd be exposing your password out in the open (in the JSON) but for scripts written in languages other than Node, this should work.
Does this sound good to you @mburszley? Probably deserves a separate issue though for more discussion.
@nandahkrishna agreed it's probably right for a different issue. considering we're dealing with secrets (the passphrase), a config file does sound appropriate. Maybe allow setting configuration through environment variables?
That sounds like a good idea, but I think I’ll let @mohanpierce99 take a call on this one. Meanwhile let’s carry over the discussion to a new issue and reference this one over there for context. Shall I do it, @mburszley or would you be okay with opening the issue?
@nandahkrishna I'll let y'all figure out how you want to organize the issues on the tracker surrounding the docs + feature request.