{"id":39664030,"url":"https://github.com/flushwhy/nvflush","last_synced_at":"2026-01-18T09:26:46.444Z","repository":{"id":258582161,"uuid":"873582282","full_name":"flushwhy/nvflush","owner":"flushwhy","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-08T08:51:27.000Z","size":136,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-08T09:50:26.765Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flushwhy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"flushwhy","patreon":"flushwhy","open_collective":null,"ko_fi":"flush","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2024-10-16T12:11:47.000Z","updated_at":"2025-07-08T08:51:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"5c99895f-5495-4818-866f-2e3aac6569b1","html_url":"https://github.com/flushwhy/nvflush","commit_stats":null,"previous_names":["flushwhy/nvflush"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flushwhy/nvflush","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flushwhy%2Fnvflush","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flushwhy%2Fnvflush/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flushwhy%2Fnvflush/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flushwhy%2Fnvflush/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flushwhy","download_url":"https://codeload.github.com/flushwhy/nvflush/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flushwhy%2Fnvflush/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28534159,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-18T09:26:45.588Z","updated_at":"2026-01-18T09:26:46.429Z","avatar_url":"https://github.com/flushwhy.png","language":"Lua","funding_links":["https://github.com/sponsors/flushwhy","https://patreon.com/flushwhy","https://ko-fi.com/flush"],"categories":[],"sub_categories":[],"readme":"# Neovim Config (Kickstart-based, VSCode-friendly)\n\n## Overview\nThis 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.\n\n### About Kickstart.nvim (The Foundation)\nThis configuration was originally based on `kickstart.nvim`. The key principles from its introductory guide are:\n\n*   **Purpose of Kickstart.nvim**: It's a starting point, not a full distribution, designed for users to understand and customize their Neovim setup.\n*   **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`.\n*   **Essential First Steps for New Neovim Users**:\n    *   Run the command `:Tutor` in Neovim to learn the basics.\n    *   Read the output of `:help` to understand how to navigate and use Neovim's extensive built-in documentation.\n    *   A helpful keymap `\u003cspace\u003esh` is often provided to search the help documentation.\n*   **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.\n*   **Troubleshooting**: If you encounter issues, especially during initial setup, running `:checkhealth` in Neovim can provide useful diagnostic information.\n\n## Quick Start\n\n### Requirements (keep from Kickstart)\n- Neovim (latest stable or nightly recommended) v11+\n- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)\n- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)\n- Clipboard tool (xclip/xsel/win32yank or other depending on platform)\n- [Nerd Font](https://www.nerdfonts.com/) (optional, for icons)\n- Language-specific tools (e.g., `npm` for TypeScript, `go` for Golang, etc.)\n\n\u003e See [Install Recipes](#Install-Recipes) for platform-specific notes and quick install snippets.\n\n### Where to Put This Config\n| OS | PATH |\n| :- | :--- |\n| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |\n| Windows (cmd)| `%localappdata%\\nvim\\` |\n| Windows (powershell)| `$env:LOCALAPPDATA\\nvim\\` |\n\n---\n\n## Major Plugins \u0026 Features\n- **LSP**: Full support for C++, Rust, Python, Lua (via `nvim-lspconfig`, `mason.nvim`)\n- **Autoformatting**: Python (`black`, `isort`), Rust (`rustfmt`), Lua (`stylua`)\n- **Treesitter**: Modern syntax highlighting and code navigation\n- **Fuzzy Finder**: Telescope\n- **AI Completion**: Codeium (accept with `\u003cC-g\u003e`)\n- **Autocompletion**: nvim-cmp\n- **Git Integration**: gitsigns\n- **File Explorer**: neo-tree\n\n---\n\n## Keybinds (VSCode User Friendly)\n\n| Action                          | Keybinding             | Plugin/Feature        |\n|----------------------------------|------------------------|-----------------------|\n| Accept Codeium Suggestion        | `\u003cC-g\u003e` (in insert)    | Codeium               |\n| Completion Menu (LSP/cmp)        | `\u003cTab\u003e`, `\u003cS-Tab\u003e`     | nvim-cmp/LSP/snippet  |\n| Next/Prev Completion             | `\u003cTab\u003e`, `\u003cS-Tab\u003e`     | nvim-cmp              |\n| Confirm Completion               | `\u003cCR\u003e`                 | nvim-cmp              |\n| Format Buffer                    | `\u003cleader\u003ef`            | conform.nvim          |\n| Go to Definition                 | `gd`                   | LSP/Telescope         |\n| Find References                  | `gr`                   | LSP/Telescope         |\n| Go to Implementation             | `gI`                   | LSP/Telescope         |\n| Go to Type Definition            | `\u003cleader\u003eD`            | LSP/Telescope         |\n| Document Symbols                 | `\u003cleader\u003eds`           | LSP/Telescope         |\n| Workspace Symbols                | `\u003cleader\u003ews`           | LSP/Telescope         |\n| Rename Symbol                    | `\u003cleader\u003ern`           | LSP                   |\n| Code Action                      | `\u003cleader\u003eca`           | LSP                   |\n| Toggle Inlay Hints               | `\u003cleader\u003eth`           | LSP                   |\n| File Explorer (Reveal)           | `\\`                    | neo-tree              |\n| Fuzzy Find Files                 | `\u003cleader\u003e\u003cspace\u003e`      | Telescope             |\n| Fuzzy Find in Files (grep)       | `\u003cleader\u003e/`            | Telescope             |\n| Git Status/Signs                 | (see gitsigns docs)    | gitsigns              |\n| **CMake: Generate (configure)**  | `\u003cleader\u003ecg`           | cmake-tools.nvim      |\n| **CMake: Build**                 | `\u003cleader\u003ecb`           | cmake-tools.nvim      |\n| **CMake: Clean**                 | `\u003cleader\u003ecc`           | cmake-tools.nvim      |\n| **CMake: Test**                  | `\u003cleader\u003ect`           | cmake-tools.nvim      |\n| **CMake: Run target**            | `\u003cleader\u003ecx`           | cmake-tools.nvim      |\n| **CMake: Select Build Type**     | `\u003cleader\u003ecs`           | cmake-tools.nvim      |\n| **Harpoon: Add current file**  | `\u003cleader\u003ea`            | Harpoon               |\n| **Harpoon: Toggle quick menu** | `\u003cleader\u003ehm`           | Harpoon               |\n| **Harpoon: Go to file 1**      | `\u003cleader\u003eh1`           | Harpoon               |\n| **Harpoon: Go to file 2**      | `\u003cleader\u003eh2`           | Harpoon               |\n| **Harpoon: Go to file 3**      | `\u003cleader\u003eh3`           | Harpoon               |\n| **Harpoon: Go to file 4**      | `\u003cleader\u003eh4`           | Harpoon               |\n| **Neogit: Open Git Status**    | `\u003cleader\u003egs`           | Neogit                |\n| **Gitsigns: Stage Hunk**       | `\u003cleader\u003egh`           | Gitsigns              |\n| **Gitsigns: Reset Hunk**       | `\u003cleader\u003egr`           | Gitsigns              |\n| **Gitsigns: Stage Buffer**     | `\u003cleader\u003egH`           | Gitsigns              |\n| **Gitsigns: Undo Stage Hunk**  | `\u003cleader\u003egu`           | Gitsigns              |\n| **Gitsigns: Reset Buffer**     | `\u003cleader\u003egR`           | Gitsigns              |\n| **Gitsigns: Preview Hunk**     | `\u003cleader\u003egp`           | Gitsigns              |\n| **Gitsigns: Blame Line**       | `\u003cleader\u003egb`           | Gitsigns              |\n| **Gitsigns: Toggle Blame**     | `\u003cleader\u003egB`           | Gitsigns              |\n| **Gitsigns: Diff Hunk**        | `\u003cleader\u003egd`           | Gitsigns              |\n| **Gitsigns: Toggle Deleted**   | `\u003cleader\u003egD`           | Gitsigns              |\n| *Gitsigns: Next Hunk*          | `]h`                   | Gitsigns              |\n| *Gitsigns: Prev Hunk*          | `[h`                   | Gitsigns              |\n\n- `\u003cleader\u003e` is usually mapped to `\\` or `,` (see your `init.lua` if unsure)\n- Most LSP/Telescope bindings work in normal mode\n- Codeium accept is only in insert mode\n\n---\n\n## CMake Integration (VSCode-like)\n\n- **CMake syntax highlighting**: Provided by Treesitter (`cmake` parser enabled)\n- **CMake workflow**: Powered by [Civitasv/cmake-tools.nvim](https://github.com/Civitasv/cmake-tools.nvim)\n- **Key features:**\n  - Run CMake configure/generate (`\u003cleader\u003ecg`)\n  - Build your project (`\u003cleader\u003ecb`)\n  - Clean build files (`\u003cleader\u003ecc`)\n  - Run tests (`\u003cleader\u003ect`)\n  - Run selected target (`\u003cleader\u003ecx`)\n  - Select build type (`\u003cleader\u003ecs`)\n- **Build directory**: Defaults to `build` inside your project (like VSCode CMake Tools)\n- **Status bar**: (Optional) See plugin docs for statusline integration\n- **Debugging**: Integrates with `nvim-dap` (optional, see plugin docs)\n\nThis setup gives you a VSCode-like CMake experience inside Neovim, with all major actions available via easy keybinds.\n\n---\n\n## How to Install Language Servers \u0026 Formatters\n- Open Neovim and run `:Mason` to install/update LSPs and formatters.\n- LSPs auto-install for C++, Rust, Python, Lua.\n- Formatters auto-install for Python, Rust, Lua.\n\n---\n\n## Migrating from VSCode\n- Use the keybinds above for familiar navigation and code actions.\n- Fuzzy finder and file explorer behave similarly to VSCode’s Quick Open and Explorer.\n- LSP and formatting are automatic for supported languages.\n- AI code suggestions (Codeium) are available—accept with `\u003cC-g\u003e`.\n\n---\n\n## Extending \u0026 Customizing\n- Plugins are modular: see `lua/custom/plugins/` for LSP, formatting, Codeium, etc.\n- Add new plugins by creating a new `.lua` file in `lua/custom/plugins/`.\n- Keymaps can be customized in your plugin files or `init.lua`.\n\n---\n\n## Credits \u0026 License\n- Based on [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)\n- Modularized and extended for C++, Rust, Python, and AI support\n\n---\n\nHappy hacking!\n\n[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo\nso that you have your own copy that you can modify, then install by cloning the\nfork to your machine using one of the commands below, depending on your OS.\n\n\u003e **NOTE**\n\u003e Your fork's url will be something like this:\n\u003e `https://github.com/\u003cyour_github_username\u003e/kickstart.nvim.git`\n\nYou likely want to remove `lazy-lock.json` from your fork's `.gitignore` file\ntoo - it's ignored in the kickstart repo to make maintenance easier, but it's\n[recommmended to track it in version control](https://lazy.folke.io/usage/lockfile).\n\n#### Clone kickstart.nvim\n\u003e **NOTE**\n\u003e If following the recommended step above (i.e., forking the repo), replace\n\u003e `nvim-lua` with `\u003cyour_github_username\u003e` in the commands below\n\n\u003cdetails\u003e\u003csummary\u003e Linux and Mac \u003c/summary\u003e\n\n```sh\ngit clone https://github.com/nvim-lua/kickstart.nvim.git \"${XDG_CONFIG_HOME:-$HOME/.config}\"/nvim\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003e Windows \u003c/summary\u003e\n\nIf you're using `cmd.exe`:\n\n```\ngit clone https://github.com/nvim-lua/kickstart.nvim.git \"%localappdata%\\nvim\"\n```\n\nIf you're using `powershell.exe`\n\n```\ngit clone https://github.com/nvim-lua/kickstart.nvim.git \"${env:LOCALAPPDATA}\\nvim\"\n```\n\n\u003c/details\u003e\n\n### Post Installation\n\nStart Neovim\n\n```sh\nnvim\n```\n\nThat's it! Lazy will install all the plugins you have. Use `:Lazy` to view\ncurrent plugin status. Hit `q` to close the window.\n\nRead through the `init.lua` file in your configuration folder for more\ninformation about extending and exploring Neovim. That also includes\nexamples of adding popularly requested plugins.\n\n\n### Getting Started\n\n[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)\n\n### FAQ\n\n* What should I do if I already have a pre-existing neovim configuration?\n  * You should back it up and then delete all associated files.\n  * This includes your existing init.lua and the neovim files in `~/.local`\n    which can be deleted with `rm -rf ~/.local/share/nvim/`\n* Can I keep my existing configuration in parallel to kickstart?\n  * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME`\n    to maintain multiple configurations. For example, you can install the kickstart\n    configuration in `~/.config/nvim-kickstart` and create an alias:\n    ```\n    alias nvim-kickstart='NVIM_APPNAME=\"nvim-kickstart\" nvim'\n    ```\n    When you run Neovim using `nvim-kickstart` alias it will use the alternative\n    config directory and the matching local directory\n    `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim\n    distribution that you would like to try out.\n* What if I want to \"uninstall\" this configuration:\n  * See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information\n* Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files?\n  * The main purpose of kickstart is to serve as a teaching tool and a reference\n    configuration that someone can easily use to `git clone` as a basis for their own.\n    As you progress in learning Neovim and Lua, you might consider splitting `init.lua`\n    into smaller parts. A fork of kickstart that does this while maintaining the \n    same functionality is available here:\n    * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)\n  * Discussions on this topic can be found here:\n    * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)\n    * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)\n\n### Install Recipes\n\nBelow you can find OS specific install instructions for Neovim and dependencies.\n\nAfter installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.\n\n#### Windows Installation\n\n\u003cdetails\u003e\u003csummary\u003eWindows with Microsoft C++ Build Tools and CMake\u003c/summary\u003e\nInstallation may require installing build tools and updating the run command for `telescope-fzf-native`\n\nSee `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)\n\nThis requires:\n\n- Install CMake and the Microsoft C++ Build Tools on Windows\n\n```lua\n{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release \u0026\u0026 cmake --build build --config Release \u0026\u0026 cmake --install build --prefix build' }\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eWindows with gcc/make using chocolatey\u003c/summary\u003e\nAlternatively, one can install gcc and make which don't require changing the config,\nthe easiest way is to use choco:\n\n1. install [chocolatey](https://chocolatey.org/install)\neither follow the instructions on the page or use winget,\nrun in cmd as **admin**:\n```\nwinget install --accept-source-agreements chocolatey.chocolatey\n```\n\n2. install all requirements using choco, exit previous cmd and\nopen a new one so that choco path is set, and run in cmd as **admin**:\n```\nchoco install -y neovim git ripgrep wget fd unzip gzip mingw make\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eWSL (Windows Subsystem for Linux)\u003c/summary\u003e\n\n```\nwsl --install\nwsl\nsudo add-apt-repository ppa:neovim-ppa/unstable -y\nsudo apt update\nsudo apt install make gcc ripgrep unzip git xclip neovim\n```\n\u003c/details\u003e\n\n#### Linux Install\n\u003cdetails\u003e\u003csummary\u003eUbuntu Install Steps\u003c/summary\u003e\n\n```\nsudo add-apt-repository ppa:neovim-ppa/unstable -y\nsudo apt update\nsudo apt install make gcc ripgrep unzip git xclip neovim\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eDebian Install Steps\u003c/summary\u003e\n\n```\nsudo apt update\nsudo apt install make gcc ripgrep unzip git xclip curl\n\n# Now we install nvim\ncurl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz\nsudo rm -rf /opt/nvim-linux64\nsudo mkdir -p /opt/nvim-linux64\nsudo chmod a+rX /opt/nvim-linux64\nsudo tar -C /opt -xzf nvim-linux64.tar.gz\n\n# make it available in /usr/local/bin, distro installs to /usr/bin\nsudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/\n```\n\u003c/details\u003e\n\u003cdetails\u003e\u003csummary\u003eFedora Install Steps\u003c/summary\u003e\n\n```\nsudo dnf install -y gcc make git ripgrep fd-find unzip neovim\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eArch Install Steps\u003c/summary\u003e\n\n```\nsudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim\n```\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflushwhy%2Fnvflush","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflushwhy%2Fnvflush","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflushwhy%2Fnvflush/lists"}