blob: 6852f12118ff9b10c51712a73fd1bf2fe6551d30 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
# foostore
This is an humble Go tool for text and binary document encryption. It uses `AES-256-CBC` by default and the initialization vector is generated from an user input PIN.
This is for my own use. So the documentation here may be lacking. But feel free to try out yourself or ask!
## Features
* Works on MacOS, Linux and on Android via Termux.
* Encrypts and stores any type of documents and files (text, binary, etc). Meant for smaller files, such as text, PDFs, etc.
* All documents are stored in a Git repository.
* All file names are encrypted as well and kept in encrypted indices in the same Git repository.
* The indices are searchable through `fzf`, the fuzzy finder.
* The Git repository can be synchronized with N remote Git repositories (e.g. to two separate VMs for geo-redundancy).
* Text entries are edited using Helix (or any other `$EDITOR`)
* Clipboard support for MacOS and GNOME (Linux).
* Interactive `foostore` shell support.
* Can import and export documuments in batches.
* Can shred exported data again.
## Fish Shell Integration
Tab completion and a `ge` shortcut wrapper are provided for the [fish shell](https://fishshell.com/).
### Install
```bash
./install-fish.sh
exec fish
```
This copies `completions/foostore.fish` to `~/.config/fish/completions/` and `completions/ge.fish` to `~/.config/fish/functions/`.
### Usage
```bash
# Tab-complete foostore subcommands
foostore <TAB>
# ge wrapper: no arguments → interactive shell
ge
# ge wrapper: bare term → treated as search
ge mypassword # same as: foostore search mypassword
# ge wrapper: explicit commands pass through
ge cat mypassword
ge import file.txt backup/
```
Entry-name completion is gated on the `PIN` environment variable to avoid interactive PIN prompts during tab completion:
```fish
set -x PIN yourpin # enable entry completion for this session
ge <TAB>
set -e PIN # clear when done
```
See `FISH_INTEGRATION.md` for more details.
|
