summaryrefslogtreecommitdiff
path: root/src/shell-integration
diff options
context:
space:
mode:
authorJason Rayne <yo@arcayne.dev>2025-06-25 12:41:55 -0700
committerJason Rayne <yo@arcayne.dev>2025-06-25 15:46:18 -0700
commit6789b7fb6e459b8ca143b946fd0f4f7e6d8fda34 (patch)
treeb01180789a0fdf0305385e5fda92e3ba24dedec2 /src/shell-integration
parent8a2fa6485e54483332b6224f04be47c9047f1947 (diff)
docs: add shared directory section to shell-integration README
Diffstat (limited to 'src/shell-integration')
-rw-r--r--src/shell-integration/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/shell-integration/README.md b/src/shell-integration/README.md
index 1fd11091d..c09ea34db 100644
--- a/src/shell-integration/README.md
+++ b/src/shell-integration/README.md
@@ -88,3 +88,17 @@ if [[ -n $GHOSTTY_RESOURCES_DIR ]]; then
source "$GHOSTTY_RESOURCES_DIR"/shell-integration/zsh/ghostty-integration
fi
```
+
+## Shared Resources
+
+The `shared/` directory contains utilities available to all shell integrations:
+
+- `ghostty-ssh-cache`: A standalone script that manages the SSH terminfo host
+ cache for the `ssh-terminfo` shell integration feature. This script handles
+ cache file operations (list, clear, check, add) and is called by all shell
+ integrations when `ssh-terminfo` is enabled. It is also called by the
+ `+list-ssh-cache` and `+clear-ssh-cache` CLI actions, providing users with
+ direct cache management capabilities.
+
+The shared approach maintains separation of concerns by keeping shell-specific
+integration files independent of secondary logic.