Skip to content

Commit 3e8f98a

Browse files
authored
Update README.md
1 parent 83084ba commit 3e8f98a

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
1-
# pass-file
2-
A pass extension for adding arbitary files to the password store. https://www.passwordstore.org/
1+
# pass file
2+
`pass file` is a extension for adding arbitary files to the [pass](https://www.passwordstore.org/) password store. Files will be encoded using `base64` before encryption.
3+
4+
## Usage
5+
```
6+
Usage: pass file attach|retrieve pass-name [path]
7+
attach|add: add new file to password store
8+
retrieve|show|cat: retrieve file from password store and print it to stdout
9+
```
10+
11+
## Example usage
12+
Storing a PNG picture and retrieving it.
13+
```
14+
pass file attach pics/secretpic mypicture.png
15+
pass file retrieve pics/secretpic > retrieved-picture.png
16+
```
17+
Alternativley you can also use shortcuts for `attach` and `retrieve`:
18+
```
19+
pass file add article my_super_secret_revelations.txt
20+
pass file cat article
21+
```

0 commit comments

Comments
 (0)