https://github.com/DavidRR-F/quick_domains.wezterm
Quckly search and attach to wezterm domains with a click of a keybind
https://github.com/DavidRR-F/quick_domains.wezterm
domains plugin shell ssh-config wez wezterm wezterm-domains wezterm-plugin
Last synced: 20 days ago
JSON representation
Quckly search and attach to wezterm domains with a click of a keybind
- Host: GitHub
- URL: https://github.com/DavidRR-F/quick_domains.wezterm
- Owner: DavidRR-F
- License: mit
- Created: 2024-09-08T14:57:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-10T01:09:50.000Z (11 months ago)
- Last Synced: 2025-01-11T08:32:32.078Z (9 months ago)
- Topics: domains, plugin, shell, ssh-config, wez, wezterm, wezterm-domains, wezterm-plugin
- Language: Lua
- Homepage:
- Size: 56.6 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wezterm - DavidRR-F/quick_domains.wezterm - Faster way to search and attach to (SSH) domains. (Session)
README
# ⚡ Quick Domains
A faster way to search and attach to domains in wezterm. Inspired by [smart_workpace_switcher.wezterm](https://github.com/MLFlexer/smart_workspace_switcher.wezterm)
## Quick Look
#### Dependencies
There are no package dependencies, but you need to configured your
`.ssh/config` [Here](https://wezfurlong.org/wezterm/config/lua/wezterm/enumerate_ssh_hosts.html) to select ssh domains using auto-configuration with this plugin.
### 🚀 Install
This is a wezterm plugin. It can be installed by importing the repo and calling the `apply_to_config` function. It is important that the `apply_to_config` function is called after keys and key_tables have been set.
```lua
local domains = wezterm.plugin.require("https://github.com/DavidRR-F/quick_domains.wezterm")
domains.apply_to_config(config)
```
### 🎨 Configuration
The `apply_to_config` function takes a second parameter opts. To override any options simply pass a table of the desired changes.
```lua
domains.apply_to_config(
config,
{
keys = {
attach = {
key = 's',
mods = 'SHIFT',
tbl = 'tmux'
},
vsplit = {
key = 'v',
mods = 'SHIFT',
tbl = 'tmux'
},
hsplit = {
key = 'h',
mods = 'SHIFT',
tbl = 'tmux'
}
}
}
)
```
You can set a custom [wezterm format](https://wezfurlong.org/wezterm/config/lua/wezterm/format.html) for the domain fuzzy selector items
```lua
domains.formatter = function(icon, name, label)
return wezterm.format({
{ Attribute = { Italic = true } },
{ Foreground = { AnsiColor = 'Fuchsia' } },
{ Background = { Color = 'blue' } },
{ Text = icon .. ' ' .. name .. ': ' .. label },
})
end
```
You can enable auto configuration of [ssh_domains](https://wezfurlong.org/wezterm/config/lua/wezterm/enumerate_ssh_hosts.html?h=ssh) and [exec_domains](https://wezfurlong.org/wezterm/config/lua/ExecDomain.html#example-docker-domains) by disabling the ignore configurations
```lua
{
keys = ...,
icons = ...,
auto = {
ssh_ignore = false,
exec_ignore = {
ssh = false,
docker = false,
kubernetes = false
},
}
}
```
### 🛠️ Defaults
These are the current default setting the can be overridden on your `apply_to_config` function
```lua
{
keys = {
-- open domain in new tab
attach = {
-- mod keys for fuzzy domain finder
mods = 'CTRL',
-- base key for fuzzy domain finder
key = 'd',
-- key table to insert key map to if any
tbl = '',
},
-- open domain in split pane
-- excludes remote domains
-- add remote domains as exec domain for split binds
vsplit = {
key = 'v',
mods = 'CTRL',
tbl = ''
},
hsplit = {
key = 'h',
mods = 'CTRL',
tbl = ''
}
},
-- swap in and out icons for specific domains
icons = {
hosts = '',
ssh = '',
tls = '',
unix = '',
exec = '',
bash = '',
zsh = '',
fish = '',
pwsh = '',
powershell = '',
wsl = '',
windows = '',
docker = '',
kubernetes = '',
},
-- auto-configuration
auto = {
-- disable ssh multiplex auto config
ssh_ignore = true,
-- disable exec domain auto configs
exec_ignore = {
ssh = true,
docker = true,
kubernetes = true
},
},
-- default shells
docker_shell = '/bin/bash',
kubernetes_shell = '/bin/bash'
}
```
This is the current default formatter function that can be overridden
```lua
domains.formatter = function(icon, name, _)
return wezterm.format({
{ Text = icon .. ' ' .. string.lower(name) }
})
end
```
### 🔔 Events
`quick_domain.fuzzy_selector.opened`
| parameter | description |
|:----------|:------------|
| window | MuxWindow Object |
| pane | MuxPane Object |
`quick_domain.fuzzy_selector.selected`
| parameter | description |
|:----------|:------------|
| window | MuxWindow Object |
| pane | MuxPane Object |
| id | Domain ID |
`quick_domain.fuzzy_selector.canceled`
| parameter | description |
|:----------|:------------|
| window | MuxWindow Object |
| pane | MuxPane Object |