summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-05-25 09:44:55 +0300
committerPaul Buetow <paul@buetow.org>2026-05-25 09:44:55 +0300
commit63a03aac61fa3ab6e4757fe126094b234e9c743f (patch)
tree0856adb8f5e21c464ee6d9efec8110083c1e1e79 /README.md
parent236582a921e1c302c0562b9154b61dbbc71e09c6 (diff)
fix(fish): prevent file completions and glob expansion in gt.fish
- Add -f (--no-files) flag to all complete entries to block file/path completions for the gt command - Escape ** and * arguments to prevent fish from glob-expanding them into recursive file matches - Add Shell Completions section and completions row to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 565f396..cffb09d 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,20 @@ gt '100Mbps 1hr *' # rate × time → 3.6e+11 bits
gt # interactive REPL
```
+## Shell Completions
+
+Fish completions are available in [`completions/`](completions/). To install:
+
+```bash
+cp completions/gt.fish ~/.config/fish/completions/
+```
+
+Or system-wide:
+
+```bash
+sudo cp completions/gt.fish /usr/local/share/fish/vendor_completions.d/
+```
+
## Feature Guide
All features are documented in [`docs/`](docs/):
@@ -51,6 +65,7 @@ All features are documented in [`docs/`](docs/):
| Custom metrics | [custom-metrics](docs/custom-metrics.md) |
| REPL mode | [repl-mode](docs/repl-mode.md) |
| Rational number mode | [rational-mode](docs/rational-mode.md) |
+| Fish shell completions | [completions](completions/)
## Building and Testing