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.
This commit is contained in:
Jason Rayne
2025-06-25 14:46:59 -07:00
parent f617c9b3b7
commit 0ccb7cf353
2 changed files with 4 additions and 1 deletions

View File

@ -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

View File

@ -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();