From 1873add697ac9a4b9b5b73d1d6225689eebfa071 Mon Sep 17 00:00:00 2001 From: Jason Rayne Date: Wed, 25 Jun 2025 17:00:17 -0700 Subject: [PATCH] docs: call out bash dependency --- src/shell-integration/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/src/shell-integration/README.md b/src/shell-integration/README.md index c09ea34db..36a6f9de1 100644 --- a/src/shell-integration/README.md +++ b/src/shell-integration/README.md @@ -93,12 +93,18 @@ fi 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. +### ghostty-ssh-cache + +> [!NOTE] +> +> This script requires `bash` to be available in the system PATH. + +This is 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.