https://github.com/willothy/wezterm.nvim

Utilities for interacting with Wezterm from within Neovim
https://github.com/willothy/wezterm.nvim

Last synced: 3 months ago
JSON representation

Utilities for interacting with Wezterm from within Neovim

• Host: GitHub
• URL: https://github.com/willothy/wezterm.nvim
• Owner: willothy
• Created: 2023-04-15T02:52:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-26T11:08:26.000Z (10 months ago)
• Last Synced: 2025-03-28T04:11:17.775Z (4 months ago)
• Language: Lua
• Size: 53.7 KB
• Stars: 223
• Watchers: 2
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-neovim - willothy/wezterm.nvim - Functions for interacting with Wezterm. (Terminal Integration / CSV Files)
• awesome-neovim-sorted - willothy/wezterm.nvim
• awesome-neovim-sorted - willothy/wezterm.nvim

README

        
# wezterm.nvim

Utilities for interacting with the wezterm cli through Lua/neovim. Spawn tasks and switch tabs/panes, all from within Neovim.

## Demo

[Wezterm.nvim.webm](https://user-images.githubusercontent.com/38540736/232179762-0ac68014-f0dc-421c-a19f-b202da4ff663.webm)

## Installation

> Note: Requires Neovim >= 0.10

With `folke/lazy.nvim`

```lua

{

    'willothy/wezterm.nvim',

    config = true

}

```

If you don't want the `WeztermSpawn` user command, use

```lua

{

    'willothy/wezterm.nvim',

    opts = {

        create_commands = false

    }

}

```

## Usage

For API documentation, see `:h wezterm.nvim` or [`doc/wezterm.nvim.txt`](./doc/wezterm.nvim.txt).

### Functions

For keybindings, functions that take a numeric value (index, id, relno, etc.) will check vim.v.count if they aren't passed an index.

For example:

```lua

-- Switch tab by index using vim.v.count

vim.keymap.set("n", "wt", require('wezterm').switch_tab.index)

```

### User command

Use `WeztermSpawn  ...` to spawn a task in a new WezTerm tab.