docs: update to reflect changes after porting terminfo host caching to Zig

- Minor tweak to Config.zig to show the new action.
- Rolled back README.md to remove reference to the now non-existent
'shared' subdir and bash-based cache script.
This commit is contained in:
Jason Rayne
2025-07-01 17:52:36 -07:00
parent 076f742dd4
commit e25aa9f424
2 changed files with 4 additions and 23 deletions

View File

@ -2070,9 +2070,10 @@ keybind: Keybinds = .{},
/// * `ssh-terminfo` - Enable automatic terminfo installation on remote hosts.
/// Attempts to install Ghostty's terminfo entry using `infocmp` and `tic` when
/// connecting to hosts that lack it. Requires `infocmp` to be available locally
/// and `tic` to be available on remote hosts. Provides `+list-ssh-cache` and
/// `+clear-ssh-cache` CLI actions for managing the installation cache (caching
/// is otherwise automatic and requires no user intervention).
/// and `tic` to be available on remote hosts. Once terminfo is installed on a
/// remote host, it will be automatically "cached" to avoid repeat installations.
/// If desired, the `+ssh-cache` CLI action can be used to manage the installation
/// cache manually using various arguments.
///
/// SSH features work independently and can be combined for optimal experience:
/// when both `ssh-env` and `ssh-terminfo` are enabled, Ghostty will install its

View File

@ -88,23 +88,3 @@ 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
> [!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.