https://github.com/glottologist/keylog.nvim
A Neovim LUA plugin for creating keystroke heatmap
https://github.com/glottologist/keylog.nvim
heatmap keylog keystrokes lua neovim productivity vim workflow
Last synced: 3 months ago
JSON representation
A Neovim LUA plugin for creating keystroke heatmap
- Host: GitHub
- URL: https://github.com/glottologist/keylog.nvim
- Owner: glottologist
- License: mit
- Created: 2024-04-28T04:53:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-28T11:19:41.000Z (about 1 year ago)
- Last Synced: 2024-12-27T05:23:03.244Z (5 months ago)
- Topics: heatmap, keylog, keystrokes, lua, neovim, productivity, vim, workflow
- Language: Lua
- Homepage: https://github.com/glottologist/keylog.nvim
- Size: 32.2 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
keylog.nvim
## 📃 Introduction
A Neovim plugin for logging keystrokes in order to generate heatmaps
## ⚙️ Features
- Log keystrokes to a keystrokes.log data file
## ⚡ Requirements
- Neovim >= [v0.7.0](https://github.com/neovim/neovim/releases/tag/v0.7.0)
## 📦 Installation
1. Install via your favorite package manager.
```lua
-- lazy.nvim
{
"glottologist/keylog.nvim",
opts = {}
},
```
2. Setup the plugin in your `init.lua`. This step is not needed with lazy.nvim if `opts` is set as above.
```lua
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](https://github.com/glottologist/keylog.nvim/blob/main/CONTRIBUTING.md).