Skip to content

glottologist/keylog.nvim

Repository files navigation

keylog.nvim

Stargazers Issues Contributors

📃 Introduction

A Neovim plugin for logging keystrokes in order to generate heatmaps

⚙️ Features

  • Log keystrokes to a keystrokes.log data file

⚡ Requirements

📦 Installation

  1. Install via your favorite package manager.
-- lazy.nvim
{
   "glottologist/keylog.nvim",
   opts = {}
},
  1. Setup the plugin in your init.lua. This step is not needed with lazy.nvim if opts is set as above.
require("keylog").setup()

🚀 Usage

keylog.nvim is enabled by default. You can change its state with the following commands:

  • :Keylog enable enable keylog.nvim
  • :Keylog disable disable keylog.nvim
  • :Keylog toggle toggle keylog.nvim
  • :Keylog clear clear the keystrokes.log file

Your log file is at ~/.local/share/nvim/keystroke.log.

🦾 Contributing

Please read CONTRIBUTING.md.