Neovide

https://neovide.dev/
Admin
Neovide is a cross-platform graphical user interface for Neovim that provides a modern, no-nonsense...
Tokens:28,273
Snippets:413
Trust Score:8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install neov-ime.nvim with Lazy.nvim

Source: https://neovide.dev/faq.html

Install the `neov-ime.nvim` plugin for IME handling using Lazy.nvim. This snippet shows the minimal configuration required for installation.

```lua
return {
  "sevenc-nanashi/neov-ime.nvim",
}

```

--------------------------------

### Neovide Configuration File Example

Source: https://neovide.dev/config-file.html

A comprehensive example of the available settings and their default values in the TOML configuration file.

```toml
backtraces-path = "/path/to/neovide_backtraces.log" # see below for the default platform specific location
chdir = "/path/to/dir"
fork = false
frame = "full"
# grid = "420x240" # mutually exclusive with `size` and `maximized`
# size = "1200x800" # mutually exclusive with `grid` and `maximized`
idle = true
icon = "/full/path/to/neovide.ico" # Example path. Default icon is bundled. Use .icns on macOS.
maximized = false
mouse-cursor-icon = "arrow"
neovim-bin = "/usr/bin/nvim" # in reality found dynamically on $PATH if unset
no-multigrid = false
opengl = false # macOS/Windows only
# server = "/tmp/nvim.sock" # or "127.0.0.1:7777"
srgb = false # platform-specific: false (Linux/macOS) or true (Windows)
startup-message-capture = true
tabs = true
system-native-tabs = false # macOS only
system-pinned-hotkey = "cmd+ctrl+z" # macOS only
system-switcher-hotkey = "cmd+ctrl+n" # macOS only
system-new-window-hotkey = "cmd+n" # macOS only
system-hide-hotkey = "cmd+h" # macOS only
system-hide-others-hotkey = "cmd+alt+h" # macOS only
system-quit-hotkey = "cmd+q" # macOS only
system-minimize-hotkey = "cmd+m" # macOS only
system-fullscreen-hotkey = "cmd+ctrl+f" # macOS only
system-show-all-tabs-hotkey = "cmd+shift+e" # macOS only
system-tab-prev-hotkey = "cmd+shift+[" # macOS only
system-tab-next-hotkey = "cmd+shift+]" # macOS only
title-hidden = false
vsync = true
# wayland-app-id = "neovide"
wsl = false
# x11-wm-class = "neovide"
# x11-wm-class-instance = "neovide"

[font]
normal = [] # Will use the bundled Fira Code Nerd Font by default
size = 14.0

[box-drawing]
# "font-glyph", "native" or "selected-native"
mode = "font-glyph"

[box-drawing.sizes]
default = [2, 4]  # Thin and thick values respectively, for all sizes
```

--------------------------------

### Install Neovide with Pacman

Source: https://neovide.dev/installation.html

Install the stable Neovide release using Pacman from the extra repository. Ensure you have 'libxkbcommon-x11' installed if running Neovide on X11.

```bash
pacman -S neovide
```

```bash
pacman -S libxkbcommon-x11
```

--------------------------------

### Install Neovide with Scoop

Source: https://neovide.dev/installation.html

Use Scoop to install Neovide from the 'extras' bucket. Ensure the 'extras' bucket is added to your Scoop configuration.

```bash
$ scoop bucket list
main
extras

$ scoop install neovide
```

--------------------------------

### Install Rust for Building Neovide

Source: https://neovide.dev/installation.html

Install Rust using the official rustup script. This is a prerequisite for building Neovide from source on most platforms.

```bash
curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh
```

--------------------------------

### Install Build Dependencies for Linux

Source: https://neovide.dev/print.html

Install required development libraries for Ubuntu, Fedora, and Arch Linux.

```bash
sudo apt install -y curl \
    gnupg ca-certificates git \
    gcc-multilib g++-multilib cmake libssl-dev pkg-config \
    libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
    libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev libfontconfig1-dev \
    libxcursor-dev
```

```bash
sudo dnf install fontconfig-devel freetype-devel @development-tools \
    libstdc++-static libstdc++-devel
```

```bash
sudo pacman -S base-devel fontconfig freetype2 libglvnd sndio cmake \
    git gtk3 python sdl2 vulkan-intel libxkbcommon-x11
```

--------------------------------

### Install Neovide with Homebrew Cask

Source: https://neovide.dev/installation.html

Install Neovide using Homebrew Cask. This command installs the Neovide application bundle.

```bash
brew install --cask neovide
```

--------------------------------

### Install Dependencies for Neovide on Ubuntu/Debian

Source: https://neovide.dev/installation.html

Install the necessary development dependencies for building Neovide on Ubuntu or Debian-based systems using apt.

```bash
sudo apt install -y curl \
    gnupg ca-certificates git \
    gcc-multilib g++-multilib cmake libssl-dev pkg-config \
    libfreetype6-dev libasound2-dev libexpat1-dev libxcb-composite0-dev \
    libbz2-dev libsndio-dev freeglut3-dev libxmu-dev libxi-dev libfontconfig1-dev \
    libxcursor-dev
```

--------------------------------

### Handle OpenGL Context Startup Errors

Source: https://neovide.dev/print.html

Example of a panic message indicating an OpenGL version mismatch.

```text
__
Neovide panicked with the message 'Failed to create OpenGL context'

```

--------------------------------

### Install Dependencies for Neovide on Fedora

Source: https://neovide.dev/installation.html

Install the necessary development dependencies for building Neovide on Fedora using dnf.

```bash
sudo dnf install fontconfig-devel freetype-devel @development-tools \
    libstdc++-static libstdc++-devel
```

--------------------------------

### Prepare Tracy for Data Collection

Source: https://neovide.dev/troubleshooting.html

Start the Tracy capture tool to begin collecting profiling data. It will wait for Neovide to connect and start sending data.

```bash
tracy-capture -o [log-file-path]

```

--------------------------------

### Launch Neovim on a Unix Domain Socket

Source: https://neovide.dev/features.html

Starts Neovim as a headless instance listening on a Unix Domain Socket. This is a more secure alternative to TCP for local connections on Unix-like systems.

```bash
nvim --headless --listen some-existing-dir/my-nvim-instance.sock
```

--------------------------------

### Build Neovide from Source with Cargo (Windows)

Source: https://neovide.dev/installation.html

Build and install Neovide from its GitHub repository using Cargo. This method requires Rust, CMake, and LLVM to be installed.

```bash
cargo install --git https://github.com/neovide/neovide.git
```

--------------------------------

### Build Neovide from source via Cargo

Source: https://neovide.dev/print.html

Install Neovide directly from the GitHub repository using Cargo.

```bash
cargo install --git https://github.com/neovide/neovide.git
```

--------------------------------

### Install Dependencies for Neovide on Arch Linux

Source: https://neovide.dev/installation.html

Install the necessary development dependencies for building Neovide on Arch Linux using pacman. Note that an AUR package already exists.

```bash
sudo pacman -S base-devel fontconfig freetype2 libglvnd sndio cmake \
    git gtk3 python sdl2 vulkan-intel libxkbcommon-x11
```

--------------------------------

### Build Neovide from Source with Cargo (Linux/macOS)

Source: https://neovide.dev/installation.html

Fetch and build Neovide from its GitHub repository using Cargo. This method requires Rust and other development tools to be installed.

```bash
cargo install --git https://github.com/neovide/neovide
```

--------------------------------

### Launch Neovim on a Named Pipe

Source: https://neovide.dev/features.html

Starts Neovim as a headless instance listening on a Named Pipe. This method is specific to Windows systems for inter-process communication.

```bash
nvim --headless --listen //./pipe/some-known-pipe-name/with-optional-path
```

--------------------------------

### Add Neovide to NixOS System Packages

Source: https://neovide.dev/installation.html

Configure Neovide to be installed system-wide on NixOS by adding it to 'environment.systemPackages' in your 'configuration.nix' file.

```nix
environment.systemPackages = with pkgs; [
neovide
];
```

--------------------------------

### Tracy Save Confirmation

Source: https://neovide.dev/print.html

Example output confirming that the trace data has been successfully saved to the specified file.

```text
Saving trace... done!
```

--------------------------------

### Tracy Connection Status

Source: https://neovide.dev/print.html

Example output indicating that the Tracy profiler is successfully waiting for a connection.

```text
Connecting to 127.0.0.1:8086...
```

--------------------------------

### Adjust Neovide Opacity at Runtime

Source: https://neovide.dev/faq.html

Modify the window opacity at runtime on macOS using `g:neovide_opacity` and optionally `g:neovide_normal_opacity`. This example binds Command-`]`/`[` to adjust opacity.

```vimscript
let g:neovide_opacity = 0.8

function! ChangeTransparency(delta)
  let g:neovide_opacity = g:neovide_opacity + a:delta
  if g:neovide_opacity > 1
    let g:neovide_opacity = 1
  elseif g:neovide_opacity < 0
    let g:neovide_opacity = 0
  endif
endfunction

nnoremap <silent> <D-]> :call ChangeTransparency(0.01)<CR>
nnoremap <silent> <D-[> :call ChangeTransparency(-0.01)<CR>

```

--------------------------------

### Configure Neovide Scale Factor

Source: https://neovide.dev/faq.html

Adjust the UI scaling in Neovide using the `g:neovide_scale_factor` option, which multiplies the OS scale factor and font size. This example sets up keybindings to increase or decrease the scale factor.

```vimscript
let g:neovide_scale_factor=1.0
function! ChangeScaleFactor(delta)
  let g:neovide_scale_factor = g:neovide_scale_factor * a:delta
endfunction
nnoremap <expr><C-=> ChangeScaleFactor(1.25)
nnoremap <expr><C--> ChangeScaleFactor(1/1.25)

```

--------------------------------

### Display help information

Source: https://neovide.dev/command-line-reference.html

Prints details about Neovide usage.

```bash
--help or -h
```

--------------------------------

### Run Neovide with Profiling

Source: https://neovide.dev/troubleshooting.html

Launch Neovide with profiling enabled to reproduce performance issues. This command will build Neovide if it hasn't been built with profiling flags already.

```bash
cd [neovide-source-dir]
cargo run --profile profiling --features profiling -- [neovide-arguments...]

```

--------------------------------

### Open in new window

Source: https://neovide.dev/command-line-reference.html

Requests the running instance to create a new OS window. Requires --reuse-instance to be set.

```bash
--new-window
```

--------------------------------

### Version and Help Commands

Source: https://neovide.dev/print.html

Commands to display version information or help details.

```text
__
--version or -V
```

```text
__
--help or -h
```

--------------------------------

### Maximize window on startup

Source: https://neovide.dev/command-line-reference.html

Maximizes the window while keeping OS decorations visible. Cannot be used with --size or --grid.

```bash
--maximized or $NEOVIDE_MAXIMIZED
```

--------------------------------

### Display version information

Source: https://neovide.dev/command-line-reference.html

Prints the current version of the Neovide executable.

```bash
--version or -V
```

--------------------------------

### Build Neovide Application Bundle for macOS

Source: https://neovide.dev/installation.html

Build a macOS application bundle and DMG disk image for Neovide. This requires cloning the repository and running the provided build script.

```bash
GENERATE_BUNDLE_APP=true GENERATE_DMG=true ./macos-builder/run
```

```bash
open ./target/release/bundle/osx/Neovide.dmg
```

--------------------------------

### Configure macOS System Shortcuts via Environment Variables

Source: https://neovide.dev/configuration.html

Set system-wide hotkeys using launchctl environment variables.

```Shell
launchctl setenv NEOVIDE_SYSTEM_PINNED_HOTKEY "ctrl+shift+z"
launchctl setenv NEOVIDE_SYSTEM_SWITCHER_HOTKEY "ctrl+shift+n"
```

--------------------------------

### Configure macOS System Shortcuts via config.toml

Source: https://neovide.dev/configuration.html

Define system-wide hotkeys in the Neovide configuration file.

```TOML
system-pinned-hotkey = "ctrl+shift+z"
system-switcher-hotkey = "ctrl+shift+n"
```

--------------------------------

### Window Size and Geometry

Source: https://neovide.dev/print.html

Sets initial window dimensions. These options are mutually exclusive.

```text
__
--size=<width>x<height> or $NEOVIDE_SIZE=<width>x<height>
```

```text
__
--maximized or $NEOVIDE_MAXIMIZED
```

```text
__
--grid [<columns>x<lines>] or $NEOVIDE_GRID=<columns>x<lines>
```

--------------------------------

### Launch Neovim as a TCP server

Source: https://neovide.dev/features.html

Launches Neovim as a headless TCP server on localhost. This is useful for connecting a local Neovide instance to a remote Neovim process.

```bash
nvim --headless --listen localhost:6666
```

--------------------------------

### Run via WSL

Source: https://neovide.dev/command-line-reference.html

Executes Neovim from inside a WSL environment.

```bash
--wsl
```

--------------------------------

### Bring Neovide Window to Front

Source: https://neovide.dev/commands.html

Brings the Neovide platform window to the front and activates it. Useful for remote control tools or long-running tasks.

```vim
NeovideFocus
```

--------------------------------

### Connect Neovide to a Unix Domain Socket

Source: https://neovide.dev/features.html

Connects the Neovide GUI to a Neovim instance that is listening on a Unix Domain Socket. The path to the socket file must be provided.

```bash
/path/to/neovide --server=some-existing-dir/my-nvim-instance.sock
```

--------------------------------

### Connect to Server

Source: https://neovide.dev/command-line-reference.html

Specifies the named pipe or socket address to connect to.

```bash
--server <ADDRESS> or $NEOVIDE_SERVER=<ADDRESS>
```

--------------------------------

### Connect Neovide to a TCP server

Source: https://neovide.dev/features.html

Connects the Neovide GUI to a running Neovim instance that is exposed via TCP. Ensure the server address is correctly specified.

```bash
/path/to/neovide --server=localhost:6666
```

--------------------------------

### Set initial window size

Source: https://neovide.dev/command-line-reference.html

Sets the window size in pixels. Cannot be used with --maximized or --grid.

```bash
--size=<width>x<height> or $NEOVIDE_SIZE=<width>x<height>
```

--------------------------------

### Open Neovide Configuration File

Source: https://neovide.dev/commands.html

Opens the Neovide configuration file for editing, providing easy access to settings without needing to know the file path.

```vim
NeovideConfig
```

--------------------------------

### Configure startup message capture

Source: https://neovide.dev/command-line-reference.html

Controls the temporary capture of startup messages. Disabling this is useful for plugins that require initialization without external UI client message advertising.

```bash
--no-startup-message-capture, --startup-message-capture or $NEOVIDE_STARTUP_MESSAGE_CAPTURE=0|1
```

--------------------------------

### Connect Neovide to a Named Pipe

Source: https://neovide.dev/features.html

Connects the Neovide GUI to a Neovim instance listening on a Named Pipe. The pipe name is provided as the server argument.

```bash
/path/to/neovide --server=some-known-pipe-name/with-optional-path
```

--------------------------------

### Configure Window Theme

Source: https://neovide.dev/configuration.html

Sets the window theme to light, dark, or auto. Available since 0.11.0.

```VimScript
let g:neovide_theme = 'auto'
```

```Lua
vim.g.neovide_theme = 'auto'
```

--------------------------------

### UI and Theme Settings

Source: https://neovide.dev/print.html

Configuration for mouse behavior, message areas, underlines, and window themes.

```APIDOC
## Configuration: UI and Theme

### Variables
- **g:neovide_hide_mouse_when_typing** (boolean) - If true, hides the mouse cursor while typing.
- **g:neovide_message_area_drag_selection** (boolean) - Available since 0.16.0. Enables/disables drag selection in message windows.
- **g:neovide_underline_stroke_scale** (float) - Available since 0.12.0. Scales the stroke width of underlines.
- **g:neovide_theme** (string) - Available since 0.11.0. Sets the window theme. Values: 'auto', 'light', 'dark', 'bg_color'.
```

--------------------------------

### Reuse existing Neovide instance

Source: https://neovide.dev/command-line-reference.html

Forwards file-open requests to an already running Neovide instance. This path is ignored if the --server flag is active.

```bash
--reuse-instance
```

--------------------------------

### Update and Build Commands

Source: https://neovide.dev/print.html

Commands used to update dependencies and verify the build status before a release.

```bash
cargo update
cargo build
```

```bash
cargo build
```

```bash
cargo publish --workspace --dry-run
```

```bash
cargo build --frozen
```

--------------------------------

### Set initial grid size

Source: https://neovide.dev/command-line-reference.html

Sets the initial grid dimensions. Cannot be used with --size or --maximized.

```bash
--grid [<columns>x<lines>] or $NEOVIDE_GRID=<columns>x<lines>
```

--------------------------------

### Configure window frame decorations

Source: https://neovide.dev/command-line-reference.html

Sets window decorations. Options include full, none, transparent (macOS), and buttonless (macOS).

```bash
--frame or $NEOVIDE_FRAME
```

--------------------------------

### Configure sRGB support

Source: https://neovide.dev/command-line-reference.html

Controls sRGB color space rendering. Command line parameters take precedence over environment variables.

```bash
--no-srgb, --srgb or $NEOVIDE_SRGB=0|1
```

--------------------------------

### Query Neovide Version

Source: https://neovide.dev/configuration.html

Retrieve the current Neovide version string.

```VimScript
echo g:neovide_version
```

```Lua
vim.print(vim.g.neovide_version)
```

--------------------------------

### Set Neovim Binary Path

Source: https://neovide.dev/command-line-reference.html

Defines the path to the Neovim executable. Defaults to searching the PATH if unset.

```bash
--neovim-bin or $NEOVIM_BIN
```

--------------------------------

### Map Leader Key to NeovideForceClick (Vimscript)

Source: https://neovide.dev/commands.html

Maps a leader key shortcut to the `NeovideForceClick` command using Vimscript.

```vimscript
nnoremap <silent> <leader>k :NeovideForceClick<CR>
```

--------------------------------

### Inspect Channel Information

Source: https://neovide.dev/configuration.html

Retrieve detailed channel information for the Neovide instance.

```Lua
lua vim.print(vim.api.nvim_get_chan_info(vim.g.neovide_channel_id))
```

--------------------------------

### Configure VSync

Source: https://neovide.dev/command-line-reference.html

Controls VSync behavior. Command line parameters take priority over environment variables.

```bash
--no-vsync, --vsync or $NEOVIDE_VSYNC=0|1
```

--------------------------------

### Configure Window Opacity

Source: https://neovide.dev/configuration.html

Sets the overall window opacity and the specific opacity for the normal background color.

```VimScript
let g:neovide_opacity = 0.8
let g:neovide_normal_opacity = 0.8
```

```Lua
vim.g.neovide_opacity = 0.8
vim.g.neovide_normal_opacity = 0.8
```

--------------------------------

### Manage Neovide windows with Hammerspoon

Source: https://neovide.dev/print.html

Automate Neovide window focus and space movement using a Hammerspoon hotkey.

```lua
-- Neovide configuration
hs.hotkey.bind({"ctrl", "shift"}, "z", function()
  -- Get current space
  local currentSpace = hs.spaces.focusedSpace()
  -- Get neovide app
  local app = hs.application.get("neovide")
  -- If app already open:
  if app then
    -- If no main window, then open a new window
    if not app:mainWindow() then
      app:selectMenuItem("New OS Window", true)
      -- If app is already in front, then hide it
    elseif app:isFrontmost() then
      app:hide()
      -- If there is a main window somewhere, bring it to current space and to
      -- front
    else
      -- First move the main window to the current space
      hs.spaces.moveWindowToSpace(app:mainWindow(), currentSpace)
      -- Activate the app
      app:activate()
      -- Raise the main window and position correctly
      app:mainWindow():raise()
    end
    -- If app not open, open it
  else
    hs.application.launchOrFocus("neovide")
    app = hs.application.get("neovide")
  end
  -- hs.spaces.gotoSpace(currentSpace)
end)
```

--------------------------------

### Enable Profiler

Source: https://neovide.dev/configuration.html

Displays a frametime graph in the upper left corner when enabled.

```VimScript
let g:neovide_profiler = v:false
```

```Lua
vim.g.neovide_profiler = false
```

--------------------------------

### Set Working Directory

Source: https://neovide.dev/command-line-reference.html

Sets the initial working directory for Neovim. This affects relative path resolution and can also be configured in the Neovide config file.

```bash
--chdir <path> or $NEOVIDE_CHDIR
```

--------------------------------

### Build Profiling Version of Neovide

Source: https://neovide.dev/troubleshooting.html

Build Neovide with profiling enabled to collect performance data. This requires specifying both --profile profiling and --features profiling during the build process.

```bash
cd [neovide-source-dir]
cargo build --profile profiling --features profiling

```

--------------------------------

### Publish Crate Commands

Source: https://neovide.dev/print.html

Commands to publish the project crates to crates.io.

```bash
cargo publish -p neovide-derive
```

```bash
cargo publish -p neovide
```

--------------------------------

### Configure Window Identification

Source: https://neovide.dev/command-line-reference.html

Sets window identification properties for X11 or Wayland environments.

```bash
--wayland-app-id <wayland_app_id> or $NEOVIDE_APP_ID
--x11-wm-class-instance <x11_wm_class_instance> or $NEOVIDE_WM_CLASS_INSTANCE
--x11-wm-class <x11_wm_class> or $NEOVIDE_WM_CLASS
```

--------------------------------

### Run Neovide with Nix Shell

Source: https://neovide.dev/installation.html

Temporarily run Neovide using Nix shell. This command pulls the 'neovide' package from nixpkgs. On non-NixOS systems, you might need to use nixGL as a wrapper.

```bash
nix-shell -p neovide
```

--------------------------------

### Configure Floating Window Shadows

Source: https://neovide.dev/configuration.html

Configures shadow borders, virtual height, and light properties for floating windows.

```VimScript
let g:neovide_floating_shadow = v:true
let g:neovide_floating_z_height = 10
let g:neovide_light_angle_degrees = 45
let g:neovide_light_radius = 5
```

```Lua
vim.g.neovide_floating_shadow = true
vim.g.neovide_floating_z_height = 10
vim.g.neovide_light_angle_degrees = 45
vim.g.neovide_light_radius = 5
```

--------------------------------

### Map Leader Key to NeovideForceClick (Lua)

Source: https://neovide.dev/commands.html

Maps a leader key shortcut to the `NeovideForceClick` command using Lua in Neovim.

```lua
vim.keymap.set("n", "<leader>k", "<Cmd>NeovideForceClick<CR>", { silent = true })
```

--------------------------------

### Enable debug logging

Source: https://neovide.dev/command-line-reference.html

Writes trace events to a log file next to the executable.

```bash
--log
```

--------------------------------

### Configure Font Settings

Source: https://neovide.dev/configuration.html

Set the font family, size, and style using the guifont option.

```VimScript
set guifont=Source\ Code\ Pro:h14
```

```Lua
vim.o.guifont = "Source Code Pro:h14" -- text below applies for VimScript
```

--------------------------------

### Remember Window Size

Source: https://neovide.dev/configuration.html

Determines if the window size from the previous session is restored on startup. Overridden by the --size commandline option.

```VimScript
let g:neovide_remember_window_size = v:true
```

```Lua
vim.g.neovide_remember_window_size = true
```

--------------------------------

### Configure Title Bar Colors

Source: https://neovide.dev/configuration.html

Sets the background and text colors for the window title bar.

```VimScript
let g:neovide_title_background_color = "green"
let g:neovide_title_text_color = "pink"
```

```Lua
vim.g.neovide_title_background_color = string.format(
    "%x",
    vim.api.nvim_get_hl(0, {id=vim.api.nvim_get_hl_id_by_name("Normal")}).bg
)

vim.g.neovide_title_text_color = "pink"
```

--------------------------------

### Animation Settings

Source: https://neovide.dev/print.html

Configuration for window position and scrolling animations.

```APIDOC
## Configuration: Animation Settings

### Variables
- **g:neovide_position_animation_length** (float) - Time in seconds for window position animations (e.g., :split). Set to 0 to disable.
- **g:neovide_scroll_animation_length** (float) - Duration of scroll animations in seconds.
- **g:neovide_scroll_animation_far_lines** (int) - Available since 0.12.0. Number of lines to animate when scrolling more than one screen. Set to 0 to snap, or a large number to always animate.
```

--------------------------------

### Progress Bar Settings

Source: https://neovide.dev/print.html

Configuration for the built-in progress bar (Available since 0.16.0).

```APIDOC
## Configuration: Progress Bar

### Variables
- **g:neovide_progress_bar_enabled** (boolean) - Enables or disables the progress bar.
- **g:neovide_progress_bar_height** (float) - Height of the progress bar in pixels.
- **g:neovide_progress_bar_animation_speed** (float) - Speed of the progress bar animation.
- **g:neovide_progress_bar_hide_delay** (float) - Delay in seconds before hiding the bar after reaching 100%.
```

--------------------------------

### Handle IME events with preedit and commit handlers

Source: https://neovide.dev/print.html

Override these handlers to customize IME behavior. Requires Neovim Nightly Dec 2 2025 or later.

```lua
---@param preedit_raw_text string
--- This values show the cursor begin position. The position is byte-wise indexed.
---@param cursor_offset_start integer
--- This values show the cursor end position. The position is byte-wise indexed.
---@param cursor_offset_end integer
M.preedit_handler = function(preedit_raw_text, cursor_offset_start, cursor_offset_end) end
    -- handle pre-edit event...
end

---@param commit_raw_text string
---@param commit_formatted_text string It's escaped.
neovide.commit_handler = function (commit_raw_text, commit_formatted_text)
    -- handle commit event...
end
```

--------------------------------

### Add Homebrew Binaries to PATH

Source: https://neovide.dev/installation.html

If Neovide is not found by your shell, add the Homebrew binary directory to your PATH environment variable. This command modifies the system's launchd configuration for user paths.

```bash
sudo launchctl config user path "$(brew --prefix)/bin:${PATH}"
```

--------------------------------

### Configure macOS Option Key as Meta

Source: https://neovide.dev/configuration.html

Interprets Alt key combinations as Meta keys. Available since 0.13.0.

```VimScript
let g:neovide_input_macos_option_key_is_meta = 'only_left'
```

```Lua
vim.g.neovide_input_macos_option_key_is_meta = 'only_left'
```

--------------------------------

### Connect Neovide to a forwarded Unix Domain Socket

Source: https://neovide.dev/features.html

Connects Neovide to a Neovim instance whose Unix Domain Socket has been forwarded over SSH. Use the local path of the forwarded socket.

```bash
/path/to/neovide --server=/path/to/local/socket
```

--------------------------------

### Logging and Debugging

Source: https://neovide.dev/print.html

Enables file-based logging for troubleshooting.

```text
__
--log
```

--------------------------------

### Adjust Neovide window opacity with keybindings

Source: https://neovide.dev/print.html

Use these snippets to bind Command-keys to increment or decrement the window opacity at runtime.

```VimScript
let g:neovide_opacity = 0.8

function! ChangeTransparency(delta)
  let g:neovide_opacity = g:neovide_opacity + a:delta
  if g:neovide_opacity > 1
    let g:neovide_opacity = 1
  elseif g:neovide_opacity < 0
    let g:neovide_opacity = 0
  endif
endfunction

nnoremap <silent> <D-]> :call ChangeTransparency(0.01)<CR>
nnoremap <silent> <D-[> :call ChangeTransparency(-0.01)<CR>
```

```Lua
vim.g.neovide_opacity = 0.8

local change_transparency = function(delta)
  local next_value = (vim.g.neovide_opacity or 1) + delta
  vim.g.neovide_opacity = math.min(1, math.max(0, next_value))
end

vim.keymap.set({ "n", "v", "o" }, "<D-]>", function()
  change_transparency(0.01)
end, { desc = "Increase Neovide opacity" })
vim.keymap.set({ "n", "v", "o" }, "<D-[>", function()
  change_transparency(-0.01)
end, { desc = "Decrease Neovide opacity" })
```

--------------------------------

### Cursor and Window Appearance

Source: https://neovide.dev/print.html

Configures mouse cursor icons, window title visibility, and application icons.

```text
__
--mouse-cursor-icon or $NEOVIDE_MOUSE_CURSOR_ICON="arrow|i-beam"
```

```text
__
--title-hidden or $NEOVIDE_TITLE_HIDDEN
```

```text
__
--icon <path>
```

--------------------------------

### Enable Mouse Grid Detection

Source: https://neovide.dev/configuration.html

Enable experimental mouse grid detection for improved compatibility.

```VimScript
let g:neovide_has_mouse_grid_detection = v:true
```

```Lua
vim.g.neovide_has_mouse_grid_detection = true
```

--------------------------------

### Configure PATH for Homebrew on macOS

Source: https://neovide.dev/print.html

Update the user path configuration if Neovide is not found by the shell.

```bash
sudo launchctl config user path "$(brew --prefix)/bin:${PATH}"
```

--------------------------------

### Replicate Terminal Keybindings in Neovide

Source: https://neovide.dev/print.html

Configures common keyboard shortcuts for saving, copying, and pasting within Neovide.

```lua
if vim.g.neovide then
  local function save() vim.cmd.write() end
  local function copy() vim.cmd([[normal! "+y]]) end
  local function paste() vim.api.nvim_paste(vim.fn.getreg("+"), true, -1) end

  vim.keymap.set({ "n", "i", "v" }, "<D-s>", save, { desc = "Save" })
  vim.keymap.set("v", "<D-c>", copy, { silent = true, desc = "Copy" })
  vim.keymap.set({ "n", "i", "v", "c", "t" }, "<D-v>", paste, { silent = true, desc = "Paste" })
end
```

--------------------------------

### Configure macOS Native Tab Navigation

Source: https://neovide.dev/configuration.html

Set shortcuts for navigating between native tabs.

```TOML
system-tab-prev-hotkey = "cmd+shift+["
system-tab-next-hotkey = "cmd+shift+]"
```

--------------------------------

### Configure basic font and features

Source: https://neovide.dev/config-file.html

Sets the primary font family and enables specific OpenType features for that font.

```toml
[font]
normal = ["MonoLisa Nerd Font"]
size = 18

[font.features]
"MonoLisa Nerd Font" = [ "+ss01", "+ss07", "+ss11", "-calt", "+ss09", "+ss02", "+ss14" ]
```

--------------------------------

### Map Mouse Button to NeovideForceClick (Vimscript)

Source: https://neovide.dev/commands.html

Maps the X1 mouse button to the `NeovideForceClick` command using Vimscript.

```vimscript
nnoremap <silent> <X1Mouse> :NeovideForceClick<CR>
```

--------------------------------

### Bind NeovideForceClick to input

Source: https://neovide.dev/print.html

Map the NeovideForceClick command to mouse buttons or keyboard shortcuts using Lua or Vimscript.

```lua
vim.keymap.set("n", "<X1Mouse>", "<Cmd>NeovideForceClick<CR>", { silent = true })
```

```lua
vim.keymap.set("n", "<leader>k", "<Cmd>NeovideForceClick<CR>", { silent = true })
```

```vim
nnoremap <silent> <X1Mouse> :NeovideForceClick<CR>
nnoremap <silent> <leader>k :NeovideForceClick<CR>
```

--------------------------------

### Configure Particle Speed

Source: https://neovide.dev/configuration.html

Set the movement speed of particles in pixels per second.

```VimScript
let g:neovide_cursor_vfx_particle_speed = 10.0
```

```Lua
vim.g.neovide_cursor_vfx_particle_speed = 10.0
```

--------------------------------

### Set custom application icon

Source: https://neovide.dev/command-line-reference.html

Sets a custom icon for the application. Available since version 0.16.0.

```bash
--icon <path>
```

--------------------------------

### Enable Fullscreen Mode

Source: https://neovide.dev/configuration.html

Toggles windowed fullscreen mode for the application.

```VimScript
let g:neovide_fullscreen = v:true
```

```Lua
vim.g.neovide_fullscreen = true
```

--------------------------------

### Map Mouse Button to NeovideForceClick (Lua)

Source: https://neovide.dev/commands.html

Maps the X1 mouse button to the `NeovideForceClick` command using Lua in Neovim.

```lua
vim.keymap.set("n", "<X1Mouse>", "<Cmd>NeovideForceClick<CR>", { silent = true })
```

--------------------------------

### Configure Particle Opacity

Source: https://neovide.dev/configuration.html

Set the transparency level for generated particles.

```VimScript
let g:neovide_cursor_vfx_opacity = 200.0
```

```Lua
vim.g.neovide_cursor_vfx_opacity = 200.0
```

--------------------------------

### Fine-tune Text Gamma and Contrast

Source: https://neovide.dev/configuration.html

Adjust text rendering gamma and contrast settings.

```VimScript
let g:neovide_text_gamma = 0.0
let g:neovide_text_contrast = 0.5
```

```Lua
vim.g.neovide_text_gamma = 0.0
vim.g.neovide_text_contrast = 0.5
```

--------------------------------

### Hammerspoon Key Binding for Neovide

Source: https://neovide.dev/integration-with-external-tools.html

Set up a custom keyboard shortcut using Hammerspoon to open, focus, or hide Neovide. This script manages Neovide windows across different spaces.

```lua
-- Neovide configuration
hs.hotkey.bind({"ctrl", "shift"}, "z", function()
  -- Get current space
  local currentSpace = hs.spaces.focusedSpace()
  -- Get neovide app
  local app = hs.application.get("neovide")
  -- If app already open:
  if app then
    -- If no main window, then open a new window
    if not app:mainWindow() then
      app:selectMenuItem("New OS Window", true)
      -- If app is already in front, then hide it
    elseif app:isFrontmost() then
      app:hide()
      -- If there is a main window somewhere, bring it to current space and to
      -- front
    else
      -- First move the main window to the current space
      hs.spaces.moveWindowToSpace(app:mainWindow(), currentSpace)
      -- Activate the app
      app:activate()
      -- Raise the main window and position correctly
      app:mainWindow():raise()
    end
    -- If app not open, open it
  else
    hs.application.launchOrFocus("neovide")
    app = hs.application.get("neovide")
  end
  -- hs.spaces.gotoSpace(currentSpace)
end)

```

--------------------------------

### Enable macOS Simple Fullscreen

Source: https://neovide.dev/configuration.html

Hides the dock and menu bar on macOS. Available since 0.15.1.

```VimScript
let g:neovide_macos_simple_fullscreen = v:true
```

```Lua
vim.g.neovide_macos_simple_fullscreen = true
```

--------------------------------

### Register Right-Click Context Menu (Windows)

Source: https://neovide.dev/commands.html

Registers a right-click context menu item on Windows to edit files with Neovide. Use `NeovideUnregisterRightClick` to undo this action.

```vim
NeovideRegisterRightClick
```

--------------------------------

### Configure IME Input

Source: https://neovide.dev/configuration.html

Set the global variable to enable or disable IME input.

```VimScript
let g:neovide_input_ime = v:true
```

```Lua
vim.g.neovide_input_ime = true
```

--------------------------------

### Remap macOS Menu Shortcuts

Source: https://neovide.dev/configuration.html

Customize application and window menu shortcuts in config.toml.

```TOML
system-hide-hotkey = "cmd+h"
system-hide-others-hotkey = "cmd+alt+h"
system-quit-hotkey = "cmd+q"
system-new-window-hotkey = "cmd+n"
system-minimize-hotkey = "cmd+m"
system-fullscreen-hotkey = "cmd+ctrl+f"
system-show-all-tabs-hotkey = "cmd+shift+e"
```

--------------------------------

### Enable macOS Proxy Icon

Source: https://neovide.dev/configuration.html

Exposes the current file as a native macOS window proxy icon in the title bar.

```VimScript
let g:neovide_proxy_icon = v:true
```

```Lua
vim.g.neovide_proxy_icon = true
```

--------------------------------

### Configure Pixel Geometry

Source: https://neovide.dev/configuration.html

Sets the physical layout of monitor subpixels, required for subpixel antialiasing.

```VimScript
let g:neovide_pixel_geometry = "RGBH"
let g:neovide_pixel_geometry = "RGBH"
```

```Lua
vim.g.neovide_pixel_geometry = "RGBH"
vim.g.neovide_pixel_geometry = "RGBH"
```
Tokens:
Raw