You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+79-20Lines changed: 79 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,27 +30,63 @@ Using [folke/lazy.nvim](https://github.com/folke/lazy.nvim)
30
30
31
31
### Wezterm
32
32
33
-
Wezterm has a [built-in system for incorporating remote plugins](https://github.com/wez/wezterm/commit/e4ae8a844d8feaa43e1de34c5cc8b4f07ce525dd). Place the following in your Wezterm config file to get the Wezterm side of the plugin running. This will pull down the repo into your local Wezterm plugin directory.
33
+
You can either integrate the plugin directly in your `wezterm.lua` or keep it in a separate file.
Simple key-value style (like `config.font_size` or `config.hide_tab_bar_if_only_one_tab`) config overrides should work out-of-the-box. Here's an example of how to override Wezterm's font size from inside of Neovim. Note how the first argument to `require('wezterm-config').set_wezterm_user_var()` is simply the name of the corresponding config option in [Wezterm's config struct](https://wezfurlong.org/wezterm/config/lua/config/index.html):
57
+
If you prefer to keep the plugin configuration separate, create a file named `wezterm_plugin.lua`:
You can use Wezterm's built-in functionality for updating plugins. If you have `config.automatically_reload_config` set to true (the default), then the plugin *should* be updated on startup and/or on saving your config. Otherwise, you could also set a keymap to trigger reloading the config and update plugins:
141
+
For more complex configuration options that take Lua tables as their values (like `background`), you can pass them as JSON strings:
106
142
107
143
```lua
108
144
wezterm.plugin.update_all()
109
145
```
110
146
111
-
You might find it helpful to be able to clear your config overrides, especially if there's been a mistake in an override resulting in some internal Wezterm error or you just want to restore defaults. This is how you can setup a Wezterm keymap to do this:
147
+
### tmux
148
+
149
+
The plugin should play nicely with [tmux](https://github.com/tmux/tmux). Make sure the following setting is in your tmux conf file, [as advised by Wez](https://wezfurlong.org/wezterm/recipes/passing-data.html#user-vars).
150
+
151
+
```
152
+
set -g allow-passthrough on
153
+
```
154
+
155
+
## Debugging
156
+
157
+
### Logging
158
+
159
+
To enable detailed logging for debugging, you can modify the event handler to include logging statements:
The plugin should play nicely with [tmux](https://github.com/tmux/tmux). Make sure the following setting is in your tmux conf file, [as advised by Wez](https://wezfurlong.org/wezterm/recipes/passing-data.html#user-vars).
0 commit comments