Closed lllamnyp closed 4 years ago
@lllamnyp Yes, you're absolutely right, thank you for the suggestion!
We've actually encountered this before (see #38), though apparently I didn't update the docs.
The documentation was originally written with usage of the Node installation in mind - it was only later that (thanks to @MPV in #27) we created a "Docker only" installation and I threw some minimal instructions in there.
Perhaps it would be better to provide a "Docker only" version for each CLI example in the readme? While it makes sense to add -i
to the alias version of rekcod
, defining the alias to mount a single hardcoded filename probably doesn't.
I will attempt to update the docs soon-ish, unless you want to create a PR yourself. Otherwise, thanks for reporting this and for the suggestions!
Well, it wasn't "soon-ish", but I finally updated the docs to (hopefully) clarify how to use the Docker-only installation with files on the host system.
Thanks for reporting this!
The documentation suggests the following way to interpret a json file:
There is also an undocumented way to pass stdin to the tool:
Neither way works. However, if one changes
(note the
-i
flag) thencat one.json | rekcod
works, while passing a filename requires the following construct:(i.e. mount the file into the container) The documentation could be clearer on this.