This repository contains an Nvim dashboard configuration intended for snacks.nvim. The dashboard provides the familiar LazyVim-style quick actions (recent files, find files, new file, etc.) and adds a right-side projects pane plus a GitHub notifications & status tab.
- Basic LazyVim dashboard items (recent files, new file, find file, projects, etc.).
- Right-side folder / projects panel that lists your project directories for quick switching.
- GitHub notifications and status tab integrated into the dashboard UI.
- Requires GitHub CLI + gh-notify extension (see setup below).
- Neovim (your local setup that already uses LazyVim or a similar plugin manager).
- GitHub CLI (gh) installed and authenticated.
- Install from https://cli.github.com/ if you don't have it.
- gh-notify extension for GitHub CLI:
- gh extension install meiji163/gh-notify
You need to copy the snacks.lua file from this directory to ~/.config/nvim/lua/plugins/ (ln snacks.lua ~/.config/nvim/lua/plugins/)
Also install fzf-lua for most of the things to work correctly.
-
Ensure GitHub CLI is installed: gh --version
-
Install the gh-notify extension: gh extension install meiji163/gh-notify
-
Authenticate gh if you haven't already: gh auth status | gh auth login
Follow the interactive prompts from
gh auth loginto complete authentication. -
After installation & auth, restart Neovim. The dashboard's GitHub notification tab should show notifications and status (depends on the extension being available and authenticated).
- If the GitHub tab shows nothing:
- Verify
gh auth statusreturns authenticated. - Ensure the extension is installed:
gh extension list. - Try running the extension manually:
gh notify(see extension docs).
- Verify
- Dashboard not loading:
- Confirm the file(s) are being required by your Neovim config or plugin manager.
- Check for errors on Neovim startup (
:messages) and resolve any Lua errors.
