summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 26 insertions, 7 deletions
diff --git a/README.md b/README.md
index 5c543f4..218ea7c 100644
--- a/README.md
+++ b/README.md
@@ -117,7 +117,7 @@ file are encrypted with the same master password. Setting a master password
117hash is a recommended but not mandatory. 117hash is a recommended but not mandatory.
118 118
119 ```bash 119 ```bash
120 etoolkit -p 120 etoolkit --generate-master-password-hash
121 ``` 121 ```
122 122
123That command will prompt for master password and output a hash that can then 123That command will prompt for master password and output a hash that can then
@@ -127,7 +127,7 @@ The hash is only used for verifying that a correct master password has been
127provided at a later time. Issuing: 127provided at a later time. Issuing:
128 128
129 ```bash 129 ```bash
130 etoolkit -e 130 etoolkit --encrypt-value
131 ``` 131 ```
132 132
133will prompt for the master password, then for the value to be encrypted and 133will prompt for the master password, then for the value to be encrypted and
@@ -140,14 +140,24 @@ prompt if *-m* / *--multiple-values* parameter is provided. Manual decryption
140of single value(s): 140of single value(s):
141 141
142 ```bash 142 ```bash
143 etoolkit -d -m 143 etoolkit --decrypt-value --multiple-values
144 ``` 144 ```
145 145
146Another possibility is to pass the value to *etoolkit*'s *stdin* using a pipe.
147*etoolkit* will then only prompt for password and not for a value:
148
149 ```bash
150 echo mysecret | etoolkit --encrypt-value
151 ```
152
153... or if the *ETOOLKIT_MASTER_PASSWORD* env. variable is defined, its value
154will be used instead of prompting for password.
155
146Listing all available instances defined in the configuration file and then 156Listing all available instances defined in the configuration file and then
147loading a specific instance can be achieved by: 157loading a specific instance can be achieved by:
148 158
149 ```bash 159 ```bash
150 etoolkit -l 160 etoolkit --list
151 etoolkit <instance-name> 161 etoolkit <instance-name>
152 ``` 162 ```
153 163
@@ -178,7 +188,7 @@ One can also spawn a different process than an interactive shell by using the
178*-s* / *--spawn* parameter. 188*-s* / *--spawn* parameter.
179 189
180 ```bash 190 ```bash
181 etoolkit -s /bin/othershell <instance-name> 191 etoolkit --spawn /bin/othershell <instance-name>
182 ``` 192 ```
183 193
184Contact the author for questions and suggestions! :) 194Contact the author for questions and suggestions! :)
@@ -264,10 +274,19 @@ file (f.i. ~/.bashrc):
264 274
265 ```bash 275 ```bash
266 if [ -n "$ETOOLKIT_PROMPT" ]; then 276 if [ -n "$ETOOLKIT_PROMPT" ]; then
267 export PS1="$ETOOLKIT_PROMPT$PS1" 277 export PS1="$ETOOLKIT_PROMPT$PS1"
268 fi 278 fi
269 ``` 279 ```
270 280
281A quick and dirty bash completion for available instances can be set at the
282bottom of your bash startup file:
283
284 ```bash
285 complete -W '$(compgen -W "$(etoolkit -l)")' etoolkit
286 ```
287
288A complete bash completion script for *etoolkit* can be found here: [https://github.com/blackm0re/etoolkit/blob/master/completion/etoolkit.bash](https://github.com/blackm0re/etoolkit/blob/master/completion/etoolkit.bash)
289
271 290
272## Support and contributing 291## Support and contributing
273 292
@@ -281,7 +300,7 @@ Simeon Simeonov - sgs @ LiberaChat
281 300
282## [License](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) 301## [License](https://github.com/blackm0re/etoolkit/blob/master/LICENSE)
283 302
284Copyright (c) 2021, Simeon Simeonov 303Copyright (C) 2021-2022 Simeon Simeonov
285All rights reserved. 304All rights reserved.
286 305
287[Licensed](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) under the 306[Licensed](https://github.com/blackm0re/etoolkit/blob/master/LICENSE) under the