# Overview

**HyprVim** brings the power of Vim keybindings and motions to your entire Hyprland desktop environment.

HyprVim now targets Hyprland's Lua plugin/configuration flow. The guide documents the Lua setup, built-in motions and modes, command mode, WhichKey, and the optional extras.

This guide documents how to use HyprVim in detail including how to call HyprVim functions via your own lua config. Think of this as your man page.

## Getting Started

Please follow the [installation steps from the README](https://github.com/uhs-robert/hyprvim/tree/main#-installation)

Then get started with [Configuration](./01_Configuration.md).

From there, work your way through [Basics](02_Basics.md), [Modes](03_Modes.md), [Advanced](04_Advanced.md), [Which Key](05_WhichKey.md), and [Tips and Tricks](06_Tips-and-Tricks.md).

## Resources

- **GitHub:** [HyprVim Repository](https://github.com/uhs-robert/hyprvim)
- **Help Viewer:** Press `gh` in NORMAL mode or use `:help` in command mode
- **Issues:** Report bugs or request features on GitHub

<div align=right><a href="01_Configuration.md"><i>>> Next: Go to Configuration</i></a></div>