From 0ccb7cf3538e189ea25a518c48c721eee243243a Mon Sep 17 00:00:00 2001 From: Jason Rayne Date: Wed, 25 Jun 2025 14:46:59 -0700 Subject: [PATCH] docs: improve SSH cache CLI action descriptions - Clarify that +list-ssh-cache shows shell integration cached hosts - Add note about +clear-ssh-cache command and when to use it Addresses mitchellh's feedback on action descriptions. --- src/cli/action.zig | 2 +- src/cli/list_ssh_cache.zig | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/cli/action.zig b/src/cli/action.zig index 1d1c3bfa0..443fafb8a 100644 --- a/src/cli/action.zig +++ b/src/cli/action.zig @@ -43,7 +43,7 @@ pub const Action = enum { /// List keybind actions @"list-actions", - /// List hosts with Ghostty SSH terminfo installed + /// List hosts cached by SSH shell integration for terminfo installation @"list-ssh-cache", /// Clear Ghostty SSH terminfo cache diff --git a/src/cli/list_ssh_cache.zig b/src/cli/list_ssh_cache.zig index a799d95bd..b4328201d 100644 --- a/src/cli/list_ssh_cache.zig +++ b/src/cli/list_ssh_cache.zig @@ -21,6 +21,9 @@ pub const Options = struct { /// This command shows all remote hosts where Ghostty's terminfo has been successfully /// installed through the SSH integration. The cache is automatically maintained when /// connecting to remote hosts with `shell-integration-features = ssh-terminfo` enabled. +/// +/// Use `+clear-ssh-cache` to remove cached entries if you need to force terminfo +/// reinstallation or clean up stale host entries. pub fn run(alloc: Allocator) !u8 { var opts: Options = .{}; defer opts.deinit();