Skip to content

01_Configuration.md

Latest commit

 

History

History
124 lines (80 loc) · 3.87 KB

01_Configuration.md

File metadata and controls

124 lines (80 loc) · 3.87 KB

Configuration

This section assumes that you have installed to the default location per the installation instructions.

HyprVim can be configured via an optional opts table that you may pass when calling the setup() function.

All default options are listed here and the raw config code can be found here.

Option Groups

keys

Controls the chords used to enter and exit HyprVim.

  • leader defaults to SUPER
  • activate defaults to ESCAPE
  • exit defaults to SHIFT + ESCAPE

The activation chord starts NORMAL mode from Hyprland. The exit chord leaves HyprVim entirely.

applications

Controls the external programs HyprVim launches.

  • terminal is used for prompts, the help viewer, and the open-editor flow
  • term_flags lets you override terminal launch flags (useful for terminals not covered by the built-in table)
  • lock is the command run by :lock
  • editor is the editor launched by the open-editor feature

notifications

Controls desktop notifications.

  • all = true enables every notification category
  • marks shows mark events
  • warnings shows recoverable warnings
  • errors shows hard failures

updates

Note

Does not apply to users who install from the AUR. Updates are handled by your package manager.

For user who manually install, controls the self-update channel.

  • stable uses the latest GitHub release
  • nightly tracks git HEAD
  • off disables update checks
  • Any other string pins a release tag or commit SHA

which_key

Controls the WhichKey HUD. The WhichKey applies to HyprVim submaps as well as your own custom submaps.

  • enabled turns the HUD on or off
  • delay_ms controls how quickly the HUD appears
  • vim_delay_ms gives operator-pending submaps a separate delay
  • position anchors the panel
  • auto_show.disabled suppresses specific submaps
  • auto_show.enabled whitelists only the listed submaps

keymaps

Use keymaps to override or extend built-in binds. The entries are evaluated inside hyprland.lua, so local helper functions are in scope.

require("lua/plugins/hyprvim").setup({
  keymaps = {
    NORMAL = {
      { "w", function() my_custom_word() end, { desc = "custom word" } },
      { "SUPER + X", function() my_extra_action() end, { desc = "extra action" } },
    },
  },
})

Matching keys replace the built-in bind. New keys are appended.

commands

Use commands to add or override : commands.

require("lua/plugins/hyprvim").setup({
  commands = {
    browser = function() hl.dispatch(hl.dsp.exec_cmd("firefox")) end,
    files = function() hl.dispatch(hl.dsp.exec_cmd("thunar")) end,
  },
})

enable_debug

Turns on verbose logging to the system journal. Useful when you need to inspect failure paths.

max_count

Sets the upper bound for count accumulation. Counts above this are clamped.

Related Features

WhichKey

WhichKey is enabled from the which_key.enabled option. Requires eww.

See WhichKey for setup and styling details.

Mode Indicator

HyprVim does not ship a mode indicator. Use the one provided by Waybar if you want a status-bar indicator:

Extras

HyprVim also includes optional extras for a broader desktop workflow:

See all extras for the full list.