diff options
| author | Daniel Mueller <deso@posteo.net> | 2018-12-27 20:03:47 -0800 |
|---|---|---|
| committer | Daniel Mueller <deso@posteo.net> | 2018-12-27 20:03:47 -0800 |
| commit | c3b9df0dfa9ef2de2a800c4fbc5880a49da0d9bb (patch) | |
| tree | 9bac2d47a56604becc27543c56fd8343317d9660 /nitrocli/README.md | |
| parent | 0148d954b1ea3105696e9958152b679997d9be86 (diff) | |
| download | nitrocli-c3b9df0dfa9ef2de2a800c4fbc5880a49da0d9bb.tar.gz nitrocli-c3b9df0dfa9ef2de2a800c4fbc5880a49da0d9bb.tar.bz2 | |
Make 'open' and 'close' subcommands of new 'storage' command
Upon their inception, the 'open' and 'close' commands were pretty much
the only relevant commands the program provided and it made sense to
have them reside in the root namespace. By now we support more commands
and have started to structure them in a more hierarchical fashion.
To go with the flow, this change introduces a new 'storage' command and
makes the existing 'open' and 'close' commands subcommands of it. We
chose the name 'storage' (over, say, 'volume') because we plan to move
the printing of the storage related status from the 'status' root level
command into a subcommand within 'storage'.
Diffstat (limited to 'nitrocli/README.md')
| -rw-r--r-- | nitrocli/README.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md index 3e0b518..b28f09e 100644 --- a/nitrocli/README.md +++ b/nitrocli/README.md @@ -11,10 +11,11 @@ nitrocli certain commands on the [Nitrokey Storage][nitrokey-storage] device. The following commands are currently supported: -- open: Open the encrypted volume. The user PIN needs to be entered. -- close: Close the encrypted volume. - status: Report status information about the Nitrokey. - clear: Remove the user and admin PIN from gpg-agent's cache. +- storage: Work with the Nitrokey's storage. + - open: Open the encrypted volume. The user PIN needs to be entered. + - close: Close the encrypted volume. - otp: Access one-time passwords (OTP). - get: Generate a one-time password. - set: Set an OTP slot. @@ -38,7 +39,7 @@ parameter (note that some commands are organized through subcommands, which are required as well), e.g.: ```bash # Open the nitrokey's encrypted volume. -$ nitrocli open +$ nitrocli storage open $ nitrocli status Status: @@ -57,7 +58,7 @@ Status: hidden: inactive # Close it again. -$ nitrocli close +$ nitrocli storage close ``` |