summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 41 insertions, 1 deletions
diff --git a/README.md b/README.md
index 77ed9d8..6852f12 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,46 @@ This is for my own use. So the documentation here may be lacking. But feel free
* 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 `geheim` shell support.
+* 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.