derivepassphrase.git

Consult the version output in the documentation where it makes sense
Parent a70b3eb
Marco Ricci

Marco Ricci commited on 2025-02-21 22:08:27
Zeige 2 geänderte Dateien mit 31 Einfügungen und 2 Löschungen. 

Whereever we present the version output, or whereever we could
reasonably query the feature set of this `derivepassphrase`
installation, show the output of the `--version` option in the
documentation.
docs/reference/prerequisites-ssh-key.md
Zeige Datei @ 3a87b8a
... ... 
@@ -85,6 +85,31 @@ its communication socket via the `SSH_AUTH_SOCK` environment variable,
85 85 
 which is common procedure.  Therefore, [your Python installation must
86 86 
 support UNIX domain sockets][socket.AF_UNIX].
87 87
88 
+`derivepassphrase vault --version` will report on supported and on
89 
+unavailable features, including "master SSH key":
90 
+
91 
+=== "supported"
92 
+
93 
+    ~~~~ console
94 
+    $ derivepassphrase vault --version
95 
+    derivepassphrase 0.5
96 
+    Using cryptography 44.0.0
97 
+    Using click 8.1.8
98 
+
99 
+    Supported features: master SSH key.
100 
+    ~~~~
101 
+
102 
+=== "unavailable"
103 
+
104 
+    ~~~~ console
105 
+    $ derivepassphrase vault --version
106 
+    derivepassphrase 0.5
107 
+    Using cryptography 44.0.0
108 
+    Using click 8.1.8
109 
+
110 
+    Unavailable features: master SSH key.
111 
+    ~~~~
112 
+
88 113 
 ### A supported SSH key { #ssh-key }
89 114
90 115 
 For an SSH key to be usable by `derivepassphrase`, the SSH agent must
docs/tutorials/basic-setup-passphrase.md
Zeige Datei @ 3a87b8a
... ... 
@@ -71,8 +71,12 @@ You will need Python 3, and a package installer such as `pip` (bundled with Pyth
71 71 
 Check that the installation was successful.
72 72
73 73 
 ~~~~ shell-session
74 
-$ devirepassphrase --version
75 
-derivepassphrase, version 0.3.0
74 
+$ devirepassphrase vault --version
75 
+derivepassphrase 0.5
76 
+Using cryptography 44.0.0
77 
+Using click 8.1.8
78 
+
79 
+Supported features: master SSH key.
76 80 
 ~~~~
77 81
78 82 
 (…or similar output.)
79 83