Skip to content

shell-integration: clarify ssh config workaround scope #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mitchellh merged 1 commit into from
Apr 13, 2026
Merged

shell-integration: clarify ssh config workaround scope #456

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/features/shell-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,12 @@ The `ssh` shell function will _not_ be used in the following cases:
`Makefile` recipes, `cron` jobs, and command substitutions in other
programs.

For any of these cases, the most robust workaround is to configure
`SetEnv` and `SendEnv` directly in `~/.ssh/config`, which applies to
every `ssh` invocation regardless of how it was launched:
### Manual `~/.ssh/config` Configuration

If you need `TERM` and environment forwarding for cases the shell wrapper
can't cover (see above), you can configure `SetEnv` and `SendEnv`
directly in `~/.ssh/config`, which applies to every `ssh` invocation
regardless of how it was launched:

```ssh-config
# ~/.ssh/config
Expand All @@ -232,6 +235,12 @@ Host example.com
manually.
</Note>

<Note>
If the remote host already has the `xterm-ghostty` terminfo entry
installed, a `SetEnv TERM=xterm-256color` stanza will unnecessarily
downgrade `TERM`. Only use this for hosts that lack the terminfo entry.
</Note>

### Remote `sshd` Configuration

The `ssh-env` feature uses `SendEnv` to forward `COLORTERM`,
Expand Down
Loading