11# gh-dash Neovim Plugin
22
3- ## A Neovim plugin integrating the open-source gh-dash TUI for the ` gh ` cli ([ gh-dash] ( https://github.com/dlvhdr/gh-dash/ ) ).
3+ ## A Neovim plugin integrating the open-source gh-dash TUI for the ` gh ` CLI ([ gh-dash] ( https://github.com/dlvhdr/gh-dash/ ) )
4+
45> Latest version: ![ GitHub tag (latest SemVer)] ( https://img.shields.io/github/v/tag/johnseth97/gh-dash.nvim?sort=semver )
56
6- ### Features:
7+ ### Features
8+
79- ✅ Toggle gh-dash floating window with ` :GHDashToggle `
810- ✅ Optional keymap mapping via ` setup ` call
911- ✅ Background running when window hidden
10- - ✅ Statusline integration via ` require('gh_dash').status() `
12+ - ✅ Statusline integration via ` require('gh_dash').status `
1113
12- ### Installation:
14+ ### Installation
1315
1416- Install the 'gh' command line tool for your OS from [ GitHub CLI] ( https://cli.github.com/ ) .
1517
@@ -19,7 +21,8 @@ e.g. for macOS:
1921brew install gh
2022```
2123
22- - Install the ` gh-dash ` TUI as a plugin from the ` gh ` command, or mark autoinstall as true in the config function
24+ - Install the ` gh-dash ` TUI as a plugin from the ` gh ` command
25+ - Alternatively, mark autoinstall as true in the config function
2326
2427``` bash
2528gh extension install dlvhdr/gh-dash
@@ -47,12 +50,15 @@ return {
4750 },
4851}
4952```
50- - If you are not using Lazy, I assume you can figure out how to install the plugin yourself by cloning the repo.
5153
52- ### Usage:
54+ - If you are not using Lazy, I assume you can figure out how to clone the repo.
55+
56+ ### Usage
57+
5358- Call ` :GHDash ` (or ` :GHDashToggle ` ) to open or close the gh-dash popup.
5459-- Map your own keybindings via the ` keymaps.toggle ` setting.
5560- Add the following code to show presence of backgrounded gh-dash window in lualine:
61+
5662``` lua
5763require (' gh-dash' ).status () -- drop in to your lualine sections
5864```
0 commit comments