https://github.com/flushwhy/nvflush
https://github.com/flushwhy/nvflush
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flushwhy/nvflush
- Owner: flushwhy
- License: mit
- Created: 2024-10-16T12:11:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-08T08:51:27.000Z (12 months ago)
- Last Synced: 2025-07-08T09:50:26.765Z (12 months ago)
- Language: Lua
- Homepage:
- Size: 133 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Neovim Config (Kickstart-based, VSCode-friendly)
## Overview
This is a modular, easy-to-read Neovim configuration inspired by Kickstart.nvim, but split into logical files for maintainability. It is tailored for users coming from VSCode, with familiar keybinds, modern code completion, LSP, formatting, and AI code suggestions.
### About Kickstart.nvim (The Foundation)
This configuration was originally based on `kickstart.nvim`. The key principles from its introductory guide are:
* **Purpose of Kickstart.nvim**: It's a starting point, not a full distribution, designed for users to understand and customize their Neovim setup.
* **Learning Lua**: It's recommended to get familiar with Lua. A quick guide can be found at `https://learnxinyminutes.com/docs/lua/`. For Neovim's specific Lua integration, refer to `:help lua-guide`.
* **Essential First Steps for New Neovim Users**:
* Run the command `:Tutor` in Neovim to learn the basics.
* Read the output of `:help` to understand how to navigate and use Neovim's extensive built-in documentation.
* A helpful keymap `sh` is often provided to search the help documentation.
* **Guidance within the Configuration**: The original `kickstart.nvim` `init.lua` (and this adapted version) contains comments like `:help X` which point to documentation for specific settings or plugins, as well as general explanatory notes.
* **Troubleshooting**: If you encounter issues, especially during initial setup, running `:checkhealth` in Neovim can provide useful diagnostic information.
## Quick Start
### Requirements (keep from Kickstart)
- Neovim (latest stable or nightly recommended) v11+
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on platform)
- [Nerd Font](https://www.nerdfonts.com/) (optional, for icons)
- Language-specific tools (e.g., `npm` for TypeScript, `go` for Golang, etc.)
> See [Install Recipes](#Install-Recipes) for platform-specific notes and quick install snippets.
### Where to Put This Config
| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%localappdata%\nvim\` |
| Windows (powershell)| `$env:LOCALAPPDATA\nvim\` |
---
## Major Plugins & Features
- **LSP**: Full support for C++, Rust, Python, Lua (via `nvim-lspconfig`, `mason.nvim`)
- **Autoformatting**: Python (`black`, `isort`), Rust (`rustfmt`), Lua (`stylua`)
- **Treesitter**: Modern syntax highlighting and code navigation
- **Fuzzy Finder**: Telescope
- **AI Completion**: Codeium (accept with ``)
- **Autocompletion**: nvim-cmp
- **Git Integration**: gitsigns
- **File Explorer**: neo-tree
---
## Keybinds (VSCode User Friendly)
| Action | Keybinding | Plugin/Feature |
|----------------------------------|------------------------|-----------------------|
| Accept Codeium Suggestion | `` (in insert) | Codeium |
| Completion Menu (LSP/cmp) | ``, `` | nvim-cmp/LSP/snippet |
| Next/Prev Completion | ``, `` | nvim-cmp |
| Confirm Completion | `` | nvim-cmp |
| Format Buffer | `f` | conform.nvim |
| Go to Definition | `gd` | LSP/Telescope |
| Find References | `gr` | LSP/Telescope |
| Go to Implementation | `gI` | LSP/Telescope |
| Go to Type Definition | `D` | LSP/Telescope |
| Document Symbols | `ds` | LSP/Telescope |
| Workspace Symbols | `ws` | LSP/Telescope |
| Rename Symbol | `rn` | LSP |
| Code Action | `ca` | LSP |
| Toggle Inlay Hints | `th` | LSP |
| File Explorer (Reveal) | `\` | neo-tree |
| Fuzzy Find Files | `` | Telescope |
| Fuzzy Find in Files (grep) | `/` | Telescope |
| Git Status/Signs | (see gitsigns docs) | gitsigns |
| **CMake: Generate (configure)** | `cg` | cmake-tools.nvim |
| **CMake: Build** | `cb` | cmake-tools.nvim |
| **CMake: Clean** | `cc` | cmake-tools.nvim |
| **CMake: Test** | `ct` | cmake-tools.nvim |
| **CMake: Run target** | `cx` | cmake-tools.nvim |
| **CMake: Select Build Type** | `cs` | cmake-tools.nvim |
| **Harpoon: Add current file** | `a` | Harpoon |
| **Harpoon: Toggle quick menu** | `hm` | Harpoon |
| **Harpoon: Go to file 1** | `h1` | Harpoon |
| **Harpoon: Go to file 2** | `h2` | Harpoon |
| **Harpoon: Go to file 3** | `h3` | Harpoon |
| **Harpoon: Go to file 4** | `h4` | Harpoon |
| **Neogit: Open Git Status** | `gs` | Neogit |
| **Gitsigns: Stage Hunk** | `gh` | Gitsigns |
| **Gitsigns: Reset Hunk** | `gr` | Gitsigns |
| **Gitsigns: Stage Buffer** | `gH` | Gitsigns |
| **Gitsigns: Undo Stage Hunk** | `gu` | Gitsigns |
| **Gitsigns: Reset Buffer** | `gR` | Gitsigns |
| **Gitsigns: Preview Hunk** | `gp` | Gitsigns |
| **Gitsigns: Blame Line** | `gb` | Gitsigns |
| **Gitsigns: Toggle Blame** | `gB` | Gitsigns |
| **Gitsigns: Diff Hunk** | `gd` | Gitsigns |
| **Gitsigns: Toggle Deleted** | `gD` | Gitsigns |
| *Gitsigns: Next Hunk* | `]h` | Gitsigns |
| *Gitsigns: Prev Hunk* | `[h` | Gitsigns |
- `` is usually mapped to `\` or `,` (see your `init.lua` if unsure)
- Most LSP/Telescope bindings work in normal mode
- Codeium accept is only in insert mode
---
## CMake Integration (VSCode-like)
- **CMake syntax highlighting**: Provided by Treesitter (`cmake` parser enabled)
- **CMake workflow**: Powered by [Civitasv/cmake-tools.nvim](https://github.com/Civitasv/cmake-tools.nvim)
- **Key features:**
- Run CMake configure/generate (`cg`)
- Build your project (`cb`)
- Clean build files (`cc`)
- Run tests (`ct`)
- Run selected target (`cx`)
- Select build type (`cs`)
- **Build directory**: Defaults to `build` inside your project (like VSCode CMake Tools)
- **Status bar**: (Optional) See plugin docs for statusline integration
- **Debugging**: Integrates with `nvim-dap` (optional, see plugin docs)
This setup gives you a VSCode-like CMake experience inside Neovim, with all major actions available via easy keybinds.
---
## How to Install Language Servers & Formatters
- Open Neovim and run `:Mason` to install/update LSPs and formatters.
- LSPs auto-install for C++, Rust, Python, Lua.
- Formatters auto-install for Python, Rust, Lua.
---
## Migrating from VSCode
- Use the keybinds above for familiar navigation and code actions.
- Fuzzy finder and file explorer behave similarly to VSCode’s Quick Open and Explorer.
- LSP and formatting are automatic for supported languages.
- AI code suggestions (Codeium) are available—accept with ``.
---
## Extending & Customizing
- Plugins are modular: see `lua/custom/plugins/` for LSP, formatting, Codeium, etc.
- Add new plugins by creating a new `.lua` file in `lua/custom/plugins/`.
- Keymaps can be customized in your plugin files or `init.lua`.
---
## Credits & License
- Based on [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)
- Modularized and extended for C++, Rust, Python, and AI support
---
Happy hacking!
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
so that you have your own copy that you can modify, then install by cloning the
fork to your machine using one of the commands below, depending on your OS.
> **NOTE**
> Your fork's url will be something like this:
> `https://github.com//kickstart.nvim.git`
You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file
too - it's ignored in the kickstart repo to make maintenance easier, but it's
[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).
#### Clone kickstart.nvim
> **NOTE**
> If following the recommended step above (i.e., forking the repo), replace
> `nvim-lua` with `` in the commands below
Linux and Mac
```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
Windows
If you're using `cmd.exe`:
```
git clone https://github.com/nvim-lua/kickstart.nvim.git "%localappdata%\nvim"
```
If you're using `powershell.exe`
```
git clone https://github.com/nvim-lua/kickstart.nvim.git "${env:LOCALAPPDATA}\nvim"
```
### Post Installation
Start Neovim
```sh
nvim
```
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
current plugin status. Hit `q` to close the window.
Read through the `init.lua` file in your configuration folder for more
information about extending and exploring Neovim. That also includes
examples of adding popularly requested plugins.
### Getting Started
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
### FAQ
* What should I do if I already have a pre-existing neovim configuration?
* You should back it up and then delete all associated files.
* This includes your existing init.lua and the neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
* Can I keep my existing configuration in parallel to kickstart?
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the kickstart
configuration in `~/.config/nvim-kickstart` and create an alias:
```
alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
When you run Neovim using `nvim-kickstart` alias it will use the alternative
config directory and the matching local directory
`~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim
distribution that you would like to try out.
* What if I want to "uninstall" this configuration:
* See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information
* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?
* The main purpose of kickstart is to serve as a teaching tool and a reference
configuration that someone can easily use to `git clone` as a basis for their own.
As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
into smaller parts. A fork of kickstart that does this while maintaining the
same functionality is available here:
* [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
* Discussions on this topic can be found here:
* [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
* [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
### Install Recipes
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
#### Windows Installation
Windows with Microsoft C++ Build Tools and CMake
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
This requires:
- Install CMake and the Microsoft C++ Build Tools on Windows
```lua
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```
Windows with gcc/make using chocolatey
Alternatively, one can install gcc and make which don't require changing the config,
the easiest way is to use choco:
1. install [chocolatey](https://chocolatey.org/install)
either follow the instructions on the page or use winget,
run in cmd as **admin**:
```
winget install --accept-source-agreements chocolatey.chocolatey
```
2. install all requirements using choco, exit previous cmd and
open a new one so that choco path is set, and run in cmd as **admin**:
```
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
```
WSL (Windows Subsystem for Linux)
```
wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
#### Linux Install
Ubuntu Install Steps
```
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
Debian Install Steps
```
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
```
Fedora Install Steps
```
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
Arch Install Steps
```
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```