Main goal of my setup: Be platform agnostic, so it should be a very similar experience regardless of linux, mac, or windows
-
Clone this repo:
- Windows:
git clone https://github.com/JeremiahVaughan/nvim-struggle ~/AppData/Local/nvim - Linux:
git clone https://github.com/JeremiahVaughan/nvim-struggle ~/.config/nvim - Mac:
~/.config/nvim
- Windows:
-
Install nvim
brew install nvim
-
Install ripgrep for fuzzy search
-
Install make for :make command to work
- Windows:
choco install make
- Windows:
-
If on windows install 'git bash'
-
Install staticcheck for more golang static checkness
-
Install zig to avoid compilation issues
-
Install nerd-fonts-hack for Hack Nerd Font Mono
https://github.com/ryanoasis/nerd-fonts
-
Install wezterm
-
Open nvim:
nvim
-
You will see an install error, its ok, it just means something needs to be installed before it can be used so just need to install
-
Restart nvim
-
Run this to ensure everything is working properly
:checkheal 742D th
-
Install LazyGit
https://github.com/jesseduffield/lazygit
-
Install LazyDocker
https://github.com/jesseduffield/lazydocker
-
Install Delta-diff for better diff indicators for LazyGit
-
Install jq
https://jqlang.github.io/jq/download/
-
Install delta
https://github.com/dandavison/delta
-
Install k9s
https://k9scli.io/topics/install
-
Install bat (currently using this for my snippets generator)
https://github.com/sharkdp/bat?tab=readme-ov-file#installation
-
For copy paste to work on remote ssh sessions
- Mac:
use Iterm2 - Mac other:
- copy the file
.alacritty.tomlin the root of this project to$HOME/.alacritty.tomlor - copy the file
.wezterm.luain the root of this project to$HOME/.wezterm.lua
- copy the file
- Windows:
- copy the file
.alacritty.tomlin the root of this project to%APPDATA%\alacritty\alacritty.tomlor - copy the file
.wezterm.luain the root of this project to$HOME/.wezterm.lua
- copy the file
- Mac:
-
Install delve for debugging
go install github.com/go-delve/delve/cmd/dlv@latest
-
The rest.nvim plugin requires these to be installed
- All of this:
- Specific C compiler
sudo apt update && sudo apt install gcc -y
- Specific C compiler
- All of this:
-
If you plan on using terragrunt, enable provider cache so you disk doesn't bloat:
export TERRAGRUNT_PROVIDER_CACHE=1- Ref:
https://terragrunt.gruntwork.io/docs/features/provider-cache/
-
Install starship:
- From: https://starship.rs
- Windows:
- Add ./starship/Microsoft.PowerShell_profile.ps1 to the $profile location ($profile is meant to be run in powershell):
-
Set your open API key
- export OPENAI_API_KEY=
-
Install simple-chat-gpt:
go install github.com/JeremiahVaughan/simple-chat-gpt@latest -
Install git-tool:
go install github.com/JeremiahVaughan/git-tool@latest -
Restore Vimium from backup
-
Move karabiner or auto hotkey config into the correct directory
-
Install htop for monitoring resources (its like top but much easier to read)
- Unix:
brew install htop - Windows:
choco install ntop.portable
- Unix:
-
Install Flameshot and bind screen shot and snip to control+x
- Screenshot setup reference: flameshot-org/flameshot#3712 (comment)
- Shortcut name: Screen Shot
- Shortcut value: /home/piegarden/.config/nvim/screenshot.sh
- Shortcut key map: ctrl+x
-
Ensure the chrome web extension
Tab Limitis installed and set to 4 tabs -
Install http lsp:
go install github.com/JeremiahVaughan/http-lsp@latest
-
Emplace hot-key remaps files
- Windows create short cut:
- Shortcut location:
C:\Users\jv1143\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup - Shortcut target:
C:\Users\jv1143\AppData\Local\nvim\ahk\key_remaps.ahk
- Shortcut location:
- Windows create short cut:
-
Emplace .gitconfig file at ~/
-
Ubuntu assessibility options:
- Turn off those slow animations
- Opt in for large text
-
Follow kmonad README.md at ./kmonad/README.md
-
Install for dadbod plugin
- Windows:
choco install psqlhttps://dev.mysql.com/downloads/installer/- Ensure you have the correct version of mysql client installed for the corresponding server, otherwise you will get a password auth error of all things
- Windows:
-
Install One Password TUI
- Install one password CLI:
https://developer.1password.com/docs/cli/get-started/#install go install github.com/JeremiahVaughan/one-password-tui@latest
- Install one password CLI:
-
If setting up on Ubuntu:
- Enabled "Night Light" -> Settings -> Displays -> Night Light
- Setup up finger print reader
Note:
- nvim-qt is available on mac too: https://github.com/equalsraf/neovim-qt
- .ideavimrc is also saved in this directory for convenience. Move this to the HOME directory and restart Jetbrains for it to take effect.
- If you run into trouble you can read the init logs with:
:messages
Good References: - https://github.com/nvim-treesitter/nvim-treesitter/wiki/Windows-support