summaryrefslogtreecommitdiff
path: root/src/shell-integration/fish
AgeCommit message (Collapse)Author
2025-10-01shell-integration: append $GHOSTTY_BIN_DIR to $PATHJon Parise
For consistency with the termio/Exec.zig implementation, we always append to the PATH (lowest priority).
2025-09-30fix: cleaned up elvish and fish integrations for bin_dirMatthew Hrehirchuk
2025-09-30feat: add GHOSTTY_BIN_DIR to path via shell integrationMatthew Hrehirchuk
2025-08-04fix fish shell syntax for ssh-env shell integrationRobbie Vanbrabant
As discussed here https://github.com/ghostty-org/ghostty/discussions/8021 This fixes invalid fish shell syntax. As an example, run ghostty like so: `XDG_CONFIG_HOME=/tmp ghostty --shell-integration-features=ssh-env --command="/usr/bin/env fish"`. Setting XDG_CONFIG_HOME to /tmp is just to start from the default config. Before: ``` Welcome to fish, the friendly interactive shell Type help for instructions on how to use fish robbiev@neo ~/s/ghostty (fish-shell-ssh)> ssh git@github.com env: ‘command’: No such file or directory robbiev@neo ~/s/ghostty (fish-shell-ssh) [127]> ``` After: ``` Welcome to fish, the friendly interactive shell Type help for instructions on how to use fish robbiev@neo ~/s/ghostty (fish-shell-ssh)> ssh git@github.com PTY allocation request failed on channel 0 Hi robbiev! You've successfully authenticated, but GitHub does not provide shell access. Connection to github.com closed. robbiev@neo ~/s/ghostty (fish-shell-ssh) [1]> ``` My understanding of the fix follows. The script is using `command` to make sure it calls the actual ssh binary and not some intermediate shell function with the same name (`man command` explains). `env` can be useful for fish compat < 3.1, where [the KEY=value syntax was introduced](https://fishshell.com/docs/current/faq.html#how-do-i-set-or-clear-an-environment-variable). However because `command` is a builtin it doesn't work in this case. So a simple solution is this, requiring fish >= 3.1 ``` TERM="$ssh_term" command ssh $ssh_opts $argv ``` An [alternative](https://serverfault.com/questions/164305/how-can-i-set-environment-variable-for-just-one-command-in-fish-shell) for maximum fish compat could be the following: ``` begin set -lx TERM "$ssh_term" command ssh $ssh_opts $argv end ``` According to `man set`, `-l` means local to the block and `-x` means export. I'm in favour of keeping `command` as it makes the integration more predicable. The reason I went with the current fix: - It's easier to understand without knowing fish shell. - [kat found that fish 3.1 should be widely available](https://github.com/ghostty-org/ghostty/discussions/8021#discussioncomment-13877129).
2025-07-19Remove unnecessary stderr redirection in fish integrationHuaDeity
2025-07-19Fix shell variable expansion in fish SSH setupHuaDeity
2025-07-16shell-integration.fish: don't use $ssh_terminfoHuaDeity
2025-07-09shell-integration: use $GHOSTTY_BIN_DIR/ghosttyJon Parise
Locate our ghostty binary using $GHOSTTY_BIN_DIR rather than searching the PATH.
2025-07-09shell-integration: simplify "ssh target" checksJon Parise
This value is always set to a non-empty string, and we only need this value after we've determined that 'ssh_hostname' is non-empty. In bash and zsh, we also don't need to check for the 'ghostty' command before we attempt to add the target to the cache. That command will safely fail silently if it's not available.
2025-07-09fish: prefer 'command -q' to check for commandsJon Parise
This is a fish built-in 'command' option that's the more idiomatic way to check for the availability of a command. https://fishshell.com/docs/current/cmds/command.html
2025-07-08refactor: apply maintainer feedback to SSH integration scripts across all shellsJason Rayne
- Update Bash script (baseline): Simplify cache checking logic, clarify "xterm-ghostty terminfo" message, remove unnecessary ssh_opts from terminfo installation, remove extra success message - Align ZSH/Fish/Elvish with updated Bash: Remove extra success messages, adopt simplified cache checking, standardize setup messages - Apply Elvish improvements: Remove unnecessary try/catch blocks, use idiomatic error handling patterns - Apply Fish improvements: Replace string pattern matching with efficient `contains` checks on split features list
2025-07-07refactor: simplify terminfo handling and remove base64 dependencyJason Rayne
- Default ssh_term to xterm-256color to eliminate fallback assignments - Remove base64 and replace infocmp -Q2 with standard -0 -x options for compatibility - Use process substitution instead of intermediate ssh_config variable - Always set TERM explicitly since ssh_term is always defined
2025-07-07refactor: simplify SSH terminfo and environment handlingJason Rayne
- Simplify feature detection to use single wildcard check - Replace ssh_env array with simple ssh_term string variable - Use TERM environment prefix instead of save/restore pattern - Remove unnecessary backgrounded subshell for cache operations
2025-07-07refactor: simplify SSH environment variable handlingJason Rayne
- Remove complex ssh_exported_vars tracking and local environment modification in favor of trusting Ghostty's local environment - Replace regex patterns with glob-based feature detection for better performance - Fix local variable declaration consistency throughout - Streamline logic while maintaining all functionality
2025-07-05fix: optimize SSH integration and improve error handlingJason Rayne
- Replace dual-loop SSH config parsing with efficient single-pass case statement - Remove overly cautious timeout logic from cache checks for simplicity - Add base64 availability check with xterm-256color fallback when missing - Include hostname in terminfo setup messages for better UX - Maintain SendEnv/SetEnv dual approach for maximum OpenSSH compatibility (relying on SetEnv alone seems to drop some vars during my tests, despite them being explicitly included in AcceptEnv on the remote host)
2025-07-03feat(ssh): rewrite SSH cache system in native ZigJason Rayne
- Eliminates standalone bash dependency - Consolidates `+list-ssh-cache` and `+clear-ssh-cache` actions into single `+ssh-cache` action with args - Structured cache format with timestamps and expiration support - Memory-safe entry handling with proper file locking - Comprehensive hostname validation (IPv4/IPv6/domains) - Atomic updates via temp file + rename - Updated shell integrations for improved cross-platform support and reliability - Cache operations are now unit-testable
2025-06-25fix: replace non-existent GHOSTTY_VERSION with TERM_PROGRAM_VERSION in shell ↵Jason Rayne
integration GHOSTTY_VERSION was mistakenly referenced but is never set. Use TERM_PROGRAM_VERSION which is actually provided by Exec.zig from build_config.version_string.
2025-06-25style: revert fish_indent quote removalJason Rayne
forgot to disable autoformat for this buffer (again)
2025-06-25refactor: replace ghostty wrapper with proper CLI actions for terminfo cache ↵Jason Rayne
management - Add +list-ssh-cache and +clear-ssh-cache CLI actions - Remove ghostty() wrapper functions from all shell integrations - Improve variable naming in shell scripts for readability Addresses @00-kat's feedback about CLI discoverability and naming consistency. The new CLI actions follow established Ghostty patterns and are discoverable via `ghostty --help`, while maintaining clean separation of concerns between shell logic and cache management.
2025-06-25refactor: extract SSH cache functionality to shared scriptJason Rayne
Addresses feedback about separation of concerns in shell integration scripts. Extracts host caching logic to `src/shell-integration/shared/ghostty-ssh-cache` and updates all four shell integrations to use the shared script. The `shared/` subdirectory preserves the existing organizational pattern where all shell-specific code lives in subdirectories. This cleanly separates SSH transport logic from cache management while reducing code duplication by ~25%. All existing SSH integration behavior remains identical.
2025-06-25ssh-integration: replace levels with flags, optimize implementationJason Rayne
Rewrote shell functions to support the two new flags for shell-integration-features: - ssh-env: TERM compatibility + best effort environment variable propagation (anything beyond TERM will depend on what the remote host allows) - ssh-terminfo: automatic terminfo installation with control socket orchestration - Flags work independently or combined Implementation optimizations: - ~65% code reduction through unified execution path - Eliminated GHOSTTY_SSH_INTEGRATION environment variable system - Replaced complex function dispatch with direct flag detection - Consolidated 4 cache helper functions into single _ghst_cache() utility - Simplified control socket management (removed multi-step orchestration) - Subsequent connections to cached hosts are now directly executed and more reliable New additions: - If ssh-terminfo is enabled, ghostty will be wrapped to provide users with convenient commands to invoke either of the two utility functions: `ghostty ssh-cache-list` and `ghostty ssh-cache-clear`
2025-06-25fix: manual formatting pass to ensure consistency with existing patternsJason Rayne
2025-06-25fix: add client-side caching to eliminate redundant terminfo installationsJason Rayne
- Cache known hosts with terminfo in $GHOSTTY_RESOURCES_DIR/terminfo_hosts - Skip installation step for cached hosts (single connection instead of two) - Use secure file permissions (600) and atomic writes - Extract SSH target safely from command arguments - Maintains full functionality while improving user experience on repeated connections
2025-06-25fix: address comprehensive shell integration code review issuesJason Rayne
- Fix elvish function name mismatch and use conj for list operations - Simplify terminfo installation command per ghostty docs (tic -x -) - Fix conditional structure to ensure error messages always print - Remove redundant checks and optimize array initialization - Use consistent patterns across bash, fish, elvish, and zsh implementations
2025-06-25fix: use idiomatic Fish shell syntax in SSH integrationJason Rayne
- Use `set --append` for array operations - Use `type -q` for command existence checks
2025-06-25fix: clean up SSH environment variable propagationJason Rayne
2025-06-25fish: revert all formatting changesJason Rayne
Keeps only functional additions for SSH integration wrapper, preserving original line breaks and indentation to minimize diff noise per maintainer feedback.
2025-06-25refactor: simplify ssh integration environment variable checksJason Rayne
2025-06-25fix: use kebab-case for ssh-integration enum valuesJason Rayne
2025-06-25feat: add SSH integration wrapper for shell integrationJason Rayne
- Implements opt-in SSH wrapper following sudo pattern - Supports term_only, basic, and full integration levels - Fixes xterm-ghostty TERM compatibility on remote systems - Propagates shell integration environment variables - Allows for automatic installation of terminfo if desired - Addresses GitHub discussions #5892 and #4156
2025-04-07shell-integration: Fix condition for sudoFabian Boehm
A missing ";" meant the check for $TERMINFO was never executed.
2025-03-22shell-integration: use fish's native list typeJon Parise
Instead of looking for individual substrings in $GHOSTTY_SHELL_FEATURES, `string split` it into a list of feature names and use `contains` to detect their presence.
2025-03-22shell-integration: switch to $GHOSTTY_SHELL_FEATURESJon Parise
This change consolidates all three opt-out shell integration environment variables into a single opt-in $GHOSTTY_SHELL_FEATURES variable. Its value is a comma-delimited list of the enabled shell feature names (e.g. "cursor,title"). $GHOSTTY_SHELL_FEATURES is set at runtime and automatically added to the shell environment. Its value is based on the shell-integration-features configuration option. $GHOSTTY_SHELL_FEATURES is only set when at least one shell feature is enabled. It won't be set when 'shell-integration-features = false'. $GHOSTTY_SHELL_FEATURES lists only the enabled shell feature names. We could have alternatively gone in the opposite direction and listed the disabled features, letting the scripts assume each feature is on by default like we did before, but I think this explicit approach is a little safer and easier to reason about / debug. It also doesn't support the "no-" negation prefix used by the config system (e.g. "cursor,no-title"). This simplifies the implementation requirements of our (multiple) shell integration scripts, and because $GHOSTTY_SHELL_FEATURES is derived from shell-integration-features, the user-facing configuration interface retains that expressiveness. $GHOSTTY_SHELL_FEATURES is intended to primarily be an internal concern: an interface between the runtime and our shell integration scripts. It could be used by people with particular use cases who want to manually source those scripts, but that isn't the intended audience. ... and because the previous $GHOSTTY_SHELL_INTEGRATION_NO_* variables were also meant to be an internal concern, this change does not include backwards compatibility support for those names. One last advantage of a using a single $GHOSTTY_SHELL_FEATURES variable is that it can be easily forwarded to e.g. ssh sessions or other shell environments.
2025-01-21Fix sudo fish shell integrationm154k1
Set sudo_has_sudoedit_flags scope to --function.
2024-11-15Remove shebangs from non-executable configuration source scriptsAnthony
2024-05-27rename env varMitchell Hashimoto
2024-05-27refactor(shell-integration): refactor to make cases alphabeticalilk
also fix: build errors also fix: name mismatch (GHOSTTY_FISH_XDG_DIR -> GHOSTTY_INTEGRATION_DIR) also refactor elvish file to evade unobvious returns
2024-01-13add sudo wrapper as optional shell integration featureAtanas Pepechkov
2023-11-07shell-integration: implement "no-cursor" optionTim Culverhouse
Implement a "no-cursor" option for shell integration. This option acts like "detect" but doesn't set the cursor shape.
2023-07-06fish: pwd reportingMitchell Hashimoto
2023-07-06fish shell integrationMitchell Hashimoto
2023-07-06start shell-integration folder, copy into zig-outMitchell Hashimoto