pass-append

An extension for pass
Log | Files | Refs | README | LICENSE

README.md (2770B)


      1 # pass-append
      2 
      3 An extension for [pass](https://www.passwordstore.org/) (the standard Unix password manager) to append a pass-style password and copy it to the clipboard before a `pass insert -m` call.
      4 
      5 ## Motivation
      6 
      7 `pass generate` is cool. `pass insert -m # <- multiline` is cool. ¿Por qué no los dos? (Why not both?) Well, the answer is that it would be annoying to do in the pass code, I think. 
      8 
      9 ## Usage
     10 
     11 ```
     12 Usage:
     13     pass append [filename]
     14       Generates a strong password, copies it to the clipboard, and runs pass insert -m [filename]
     15           Based on the pass apppend extension, itself based on the pass backup extension.
     16     pass append help
     17         Prints this help message.
     18     pass append version
     19         Prints the version number.
     20 
     21 Example: pass append services/amazon
     22         Generates a strong password, copies it to the clipboard,
     23         and starts pass insert -m services/amazon
     24 
     25 
     26 ```
     27 
     28 ## Example
     29 Let's generate a password for this example
     30 
     31 ```
     32 pass append web/digitalocean
     33 Copied new password to clipboard:
     34 Gm,G^98w8e3YZ)Op&pi4v+Q>I
     35 Enter contents of test/test and press Ctrl+D when finished:
     36 Gm,G^98w8e3YZ)Op&pi4v+Q>I
     37 my.email@email-provider.com
     38 [master 1dd0d0b] Add generated password for test/test.
     39 ```
     40 
     41 ## Installation
     42 
     43 For installation download and place this bash script file ```apppend.bash``` into
     44 the passwordstore extension directory specified with ```$PASSWORD_STORE_EXTENSIONS_DIR```.
     45 By default this is ```~/.password-store/.extensions```.
     46 ```
     47 $ cp apppend.bash ~/.password-store/.extensions
     48 ```
     49 Give the file execution permissions:
     50 ```
     51 $ chmod 700 ~/.password-store/.extensions/apppend.bash
     52 ```
     53 Set the variable ```PASSWORD_STORE_ENABLE_EXTENSIONS```, to true to enable extensions, e.g., in your `.bashrc`
     54 ```
     55 $ export PASSWORD_STORE_ENABLE_EXTENSIONS=true
     56 ```
     57 Download and source the bash completion file ```pass-apppend.bash.completion``` for bash completion.
     58 ```
     59 $ source ~/.password-store/.bash-completions/pass-apppend.bash.completion
     60 ```
     61 Type ```pass apppend filename/identifier``` to save your first password using this method, e.g.:
     62 ```
     63 $ pass apppend web/digitalocean
     64 ```
     65 
     66 ## Requirements
     67 
     68 - `pass` from [https://www.passwordstore.org/](https://www.passwordstore.org/)
     69 - `tar` to be installed for zipping and compression.
     70 
     71 ## License
     72 This work is released under the [GNU GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/gpl-3.0.en.html).
     73 
     74 ## Notes
     75 
     76 Both files are fairly small: 95 lines (script) and 17 lines (autocompletion)  respectively. You can check them yourself quickly. No need to trust anyone.
     77 
     78 This extension is heavily based on the [pass-backup](https://github.com/8go/pass-backup) extension. Because `pass-backup` is open source, it was easy to take its architecture and use it for a different purpose.