https://github.com/mikedacre/tmux-zsh-environment

Share environmental variables more seamlessly between tmux and ZSH
https://github.com/mikedacre/tmux-zsh-environment

oh-my-zsh tmux zsh zsh-plugin

Last synced: about 1 month ago
JSON representation

Share environmental variables more seamlessly between tmux and ZSH

• Host: GitHub
• URL: https://github.com/mikedacre/tmux-zsh-environment
• Owner: MikeDacre
• License: mit
• Created: 2018-03-21T23:24:16.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-23T23:10:13.000Z (almost 7 years ago)
• Last Synced: 2024-12-29T22:29:30.138Z (about 1 month ago)
• Topics: oh-my-zsh, tmux, zsh, zsh-plugin
• Language: Shell
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tmux ZSH Environment

Tmux includes an `update-environment` command that means that any new shells

recieve the variables in `update-environment` when they are loaded. However,

existing shells do not recieve these variables, meaning that things like

`DISPLAY` become out-of-date when sshing into a machine and connecting to an

existing session.

This ZSH plugin adds a lightweight preexec hook function that runs on every new

prompt/execution, and updates the current shell environement with any variables

loaded in the tmux `show-environment` array (this includes only those variables

that were both set by `update-environment` and set in the calling environment).

By default, tmux updates the following variables:

```shell

DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY

```

If these look good to you, this plugin will work out of the box to keep those

updated, if not, you can just add the following line to your `~/.tmux.conf`:

```shell

set -g update-environment "DISPLAY SSH_CONNECTION XAUTHORIT"

```

# Installation

## [Antigen](github.com/zsh-users/antigen)

If you're using [Antigen](github.com/zsh-users/antigen), just add `antigen

bundle MikeDacre/tmux-zsh-environment` to your `.zshrc` file where you're

loading your other zsh plugins.

## [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh)

1. `mkdir -p ~/oh-my-zsh/custom/plugins`

2. `cd ~/oh-my-zsh/custom/plugins`

3. `git clone [email protected]:MikeDacre/tmux-zsh-environment`

4. `echo "plugins+=(tmux-zsh-environment)" >> ~/.zshrc`

## [Zgen](tarjoilija/zgen)

If you're using [Zgen](tarjoilija/zgen), add `zgen load MikeDacre/cdbk` to your

`.zshrc` file where you're loading your other zsh plugins.