From 6789b7fb6e459b8ca143b946fd0f4f7e6d8fda34 Mon Sep 17 00:00:00 2001 From: Jason Rayne Date: Wed, 25 Jun 2025 12:41:55 -0700 Subject: [PATCH] docs: add shared directory section to shell-integration README --- src/shell-integration/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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.