dotfiles & credit

This dotfiles repo is a fork from the great Nick Janetakis. I have extended this to fit my needs. I'm also using a modified version of Lunar Vim by Chris@Machine

Quickly Get Set Up with These Dotfiles

I'm going to try my best to provide beginning to end installation instructions for Debian, Ubuntu (native or WSL) along with macOS. Fortunately setting up most of these tools will be the same on any OS since they're not OS specific.

OS / distro specific installation steps

My set up targets tmux 3.0+ and Neovim 0.5.0+. As long as you can meet those requirements you'll be good to go.

Debian

If you're on Debian Buster, you'll want to enable backports for tmux before installing anything. Once you do that then you can proceed to the Ubuntu 20.04 LTS installation steps below.

Any version after Buster should be good to go without any backports.

Ubuntu 20.04 LTS

It's smooth sailing if you're using 20.04 LTS or newer.

sudo apt-get update && sudo apt-get install -y \
  curl \
  git \
  gnupg \
  htop \
  jq \
  pass \
  pwgen \
  python3-pip \
  ripgrep \
  rsync \
  shellcheck \
  tmux \
  unzip

The GTK version of Vim is to get +clipboard support, we'll still run terminal vim from the command line.

Other Linux distros

If you're not using Debian or Ubuntu that's ok. You can change the apt commands above to use your distro's package manager instead. Just be mindful of making sure you get tmux 3.0+ and Vim 8.1+.

macOS

I don't use a Mac but I've tracked down most of these packages in brew. Feel free to open a PR if there's a better way to install them. I haven't tested this personally but the tmux and Vim versions are good to go based on Homebrew's docs.

brew install \
  curl \
  git \
  gnupg \
  htop \
  jq \
  pass \
  pwgen \
  python \
  ripgrep \
  rsync \
  shellcheck \
  tmux \
  unzip \
  vim

Installing everything else (OS neutral)

I would make an effort to read the comments for each command before copy / pasting them into a terminal just so you know what's getting installed. You may want to modify some of these things based on which tools you want.

Install these dotfiles and various tools on your system

# Clone down this dotfiles repo to your home directory. Feel free to place
# this anywhere you want, but remember where you've cloned things to.
git clone https://github.com/alexmk92/dotfiles ~/dotfiles && \
  # Optionally remove these files if you plan to symlink them
  # not recommended if you have custom bashrc, aliases and
  # profile already configured
  rm -f ~/.bashrc  && \
  rm -f ~/.profile && \
  rm -f ~/.aliases && \
  # Make sure you do this step
  nano ~/dotfiles/.gitconfig.user

# Create symlinks to various dotfiles. If you didn't clone it to ~/dotfiles
# then adjust the ln -s symlink source (left side) to where you cloned it.
#
# NOTE: The last one is WSL 1 / 2 specific. Don't do it on native Linux / macOS.
mkdir -p ~/.local/bin \
  && mkdir -p ~/.ssh \
  && ln -s ~/dotfiles/.ssh/init.sh ~/.ssh/init.sh \
  && ln -s ~/dotfiles/.aliases ~/.aliases \
  && ln -s ~/dotfiles/.ssh ~/.ssh
  && ln -s ~/dotfiles/.bashrc ~/.bashrc \
  && ln -s ~/dotfiles/.inputrc ~/inputrc \
  && ln -s ~/dotfiles/.gemrc ~/.gemrc \
  && ln -s ~/dotfiles/.gitconfig ~/.gitconfig \
  && ln -s ~/dotfiles/.profile ~/.profile \
  && ln -s ~/dotfiles/.tmux.conf ~/.tmux.conf \
  && ln -s ~/dotfiles/.gitignore_global ~/.gitignore_global \
  && ln -s ~/dotfiles/.local/bin/set-theme ~/.local/bin/set-theme \
  && sudo ln -s ~/dotfiles/etc/wsl.conf /etc/wsl.conf 



# Install keychain for auto mounting ssh keys
sudo apt-get install keychain

# Create a directory for all of your projects
mkdir ~/code

# Create your own personal ~/.gitconfig.user file. After copying the file,
# you should edit it to have your name and email address so git can use it
# don't symlink this so version control doesn't pick it up
cp ~/dotfiles/.gitconfig.user ~/.gitconfig.user

# Install TPM (Tmux plugin manager).
git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm

# Install FZF (fuzzy finder on the terminal and used by a Vim plugin).
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf && ~/.fzf/install

# Install ASDF (version manager which I use for non-Dockerized apps).
git clone https://github.com/asdf-vm/asdf.git ~/.asdf \
  && cd ~/.asdf \
  && git checkout "$(git describe --abbrev=0 --tags)" \
  && source ~/.bashrc

# Install Node through ASDF. Even if you don't use Node / Webpack / etc., there
# is one Vim plugin (Markdown Preview) that requires Node and Yarn.
asdf plugin-add nodejs https://github.com/asdf-vm/asdf-nodejs.git \
  && bash ~/.asdf/plugins/nodejs/bin/import-release-team-keyring \
  && asdf install nodejs 12.18.3 \
  && asdf global nodejs 12.18.3 \
  && npm install --global yarn \
  && yarn -v \
  && node -v 

# Install system dependencies for Ruby on Debian / Ubuntu.
#
# Not using Debian or Ubuntu? Here's alternatives for macOS and other Linux distros:
#   https://github.com/rbenv/ruby-build/wiki#suggested-build-environment
sudo apt-get install -y autoconf bison build-essential libssl-dev libyaml-dev \
  libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libdb-dev

# If you would like to use sshfs to work on remote file systems, you'll need 
# to add this package:
# sshfs you@remote:/path/to/code ~/code/mount-dir
# Unmount with fusermount -zu ~/code/mount-dir
sudo apt-get install -y sshfs

# Install Ruby through ASDF.
asdf plugin-add ruby https://github.com/asdf-vm/asdf-ruby.git
asdf install ruby 2.7.1
asdf global ruby 2.7.1

# Install Ansible (optional)
pip3 install --user ansible

# Install AWS CLI v2 (optional)
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" \
  && unzip awscliv2.zip && sudo ./aws/install && rm awscliv2.zip

# Install Terraform (optional)
curl "https://releases.hashicorp.com/terraform/0.13.2/terraform_0.13.2_linux_amd64.zip" -o "terraform.zip" \
  && sudo unzip terraform.zip && sudo chmod +x terraform \
  && mv terraform ~/.local/bin && rm terraform.zip

Install ranger (better filesystem browser for ubuntu)

# Image support for ranger (Linux only), this is optional
sudo apt install ranger libjpeg8-dev zlib1g-dev python-dev python3-dev libxtst-dev python3-pip \
  && pip3 install ueberzug

# Install the ranger dev icons for browsing in vim
git clone https://github.com/alexanderjeurissen/ranger_devicons ~/.config/ranger/plugins/ranger_devicons

Install neovim (optional) - this is my typescript + LSP vim setup

# Install xserver on WSL otherwise opening nvim will be REALLY slow
# bashrc already exports DISPLAY and LIBGL_ALWAYS_INDIRECT
# https://stackoverflow.com/questions/61110603/how-to-set-up-working-x11-forwarding-on-wsl2
sudo apt install x11-apps

# Install luarocks package manager as Neovim is Lua based
sudo apt install build-essential libreadline-dev \
  && curl -R -O http://www.lua.org/ftp/lua-5.3.5.tar.gz \
  && tar -zxf lua-5.3.5.tar.gz \
  && cd lua-5.3.5 \
  && make linux test \
  && sudo make install \
  && wget https://luarocks.org/releases/luarocks-3.3.1.tar.gz \
  && tar zxpf luarocks-3.3.1.tar.gz \
  && cd luarocks-3.3.1 \
  && ./configure --with-lua-include=/usr/local/include \
  && make \
  && sudo make install

# REQUIRED DEPENDENCIES FROM Dotfiles
# Please make sure the ranger steps above are followed.
# Install a nerd font for devicons, I use Caskaydia Cove NF https://www.nerdfonts.com/font-downloads

# Install neovim - Bleeding edge vim
# currently using nightly build until 0.5.0 is stable
curl -LO https://github.com/neovim/neovim/releases/download/nightly/nvim.appimage \
  && chmod u+x nvim.appimage

# Install pynvim - for Xdebug in nvim
pip3 install pynvim

# Install neovim-remote - work on a remote server
pip3 install neovim-remote

# Install rust (and cargo)
curl https://sh.rustup.rs -sSf | sh \
  && source $HOME/.cargo/env

# Install ripgrep for fuzzy search
cargo install ripgrep ytop bat

# Install vim-plug (PLugin manager)
sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
       https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'

# Install Golang for vmux (if not using tmux, dont bother)
sudo apt install golang-go && \
  go get -u github.com/arl/gitmux

# Clipboard support (only do this for WSL)
sudo apt install xsel && \
  curl -sLo/tmp/win32yank.zip https://github.com/equalsraf/win32yank/releases/download/v0.0.4/win32yank-x64.zip && \
  unzip -p /tmp/win32yank.zip win32yank.exe > /tmp/win32yank.exe && \
  chmod +x /tmp/win32yank.exe && \
  mv /tmp/win32yank.exe ~/bin

# Symlink conf dirs
ln -s ~/dotfiles/.gitmux.conf ~/.gitmux.conf 

# Install LunarVim
rm -rf ~/.cache/nvim && \
rm -rf ~/.local/share/nvim && \
bash <(curl -s https://raw.githubusercontent.com/alexmk92/lunarvim/master/utils/installer/install.sh)

# If using SFTP add the appropriate
# vim-arsync file to the root (this is global git ignored)
# Ensure the ignore_dotfiles is supplied to prevent
# .vim-arsync being uploaded to the remote
# If you are using remote_passwd you need to install
# apt-get install sshpass
# If you omit the remote_passwd from the file, it will
# attempt to use your ssh-agent to connect.
#
# If you're syncing files via SFTP to/from your machine
# it would be useful to symlink the .githooks to any
# of the repos that have a .vim-arsync file associated
# this will then auto sync all files which are not
# in the ingore_path to the remote server on checkout
# meaning your home machine becomes the single source
# of truth.
#
# Use ln -s ~/dotfiles/.githooks/* ~/code/your_repo/.git/hooks
#
#  remote_host     example.com
#  remote_user    john
#  remote_passwd  secret
#  remote_path     ~/temp/
#  local_path    /home/ken/temp/vuetest/
#  ignore_path     ["build/","test/"]
#  ignore_dotfiles 1
#  auto_sync_up    1

# Install linters
npm install -g prettier && \
sudo apt install php7.4-cli && \
curl -sS https://getcomposer.org/installer -o composer-setup.php && \
php composer-setup.php --install-dir=/home/alexmk92/.local/bin --filename=composer && \
composer global require friendsofphp/php-cs-fixer

nvim
# Run the following commands 
# :PackerInstall
# :LspInstall php
# Install default language servers


# Optional
# Lazy git (for floatrem) go get github.com/jesseduffield/lazygit
# Lazy docker (for floatrem) go get github.com/jesseduffield/lazydocker

Install plugins for tmux

# Start a tmux session and install the configured plugins. You would type in
# ` followed by I (capital i) to issue the command.
tmux
`I

Optionally confirm that a few things work after closing and re-opening your terminal

# Sanity check to see if you can run some of the tools we installed.
ruby --version
node --version
ansible --version
aws --version
terraform --version

# Check to make sure git is configured with your name, email and custom settings.
git config --list

# If you're using Docker Desktop with WSL 2, these should be accessible too.
docker info
docker-compose --version

Before you start customizing certain config files, take a look at the personalization question in the FAQ.

Extra WSL 1 and WSL 2 steps

In addition to the Linux side of things, there's a few config files that I have in various directories of this dotfiles repo. These have long Windows paths.

It would be expected that you copy those over to your system while replacing "alexa" with your Windows user name if you want to use those things, such as my Microsoft Terminal settings.json file and others. Some of the paths may also contain unique IDs too, so adjust them as needed on your end.

Some of these configs expect that you have certain programs or tools installed on Windows. The tools I use blog post has a complete list of those tools so you can pick the ones you want to install.

Pay very close attention to the c/Users/Nick/.wslconfig file because it has values in there that you will very likely want to change before using it. This commit message goes into the details.

Once you've done this, feel free to run cp ~/dotfiles/c/Users/alexa/AppData/* /mnt/c/Users/YOU/AppData

Also, you should reboot to activate your /etc/wsl.conf file (symlinked earlier). That will be necessary if you want to access your mounted drives at /c or /d instead of /mnt/c or /mnt/d.

Install alacritty (optional)

This is only needed for machines which do not have a good graphical terminal editor, you can use Microsofts Terminal app. Do not follow these steps on WSL1 or WSL2 as you will need the executable which you can download a prebuilt binary from the alacritty releases

ln -s ~/dotfiles/.alacritty.yml ~/.alacritty.yml &&

git clone https://github.com/alacritty/alacritty.git && \
 cd alacritty && \
 rustup override set stable && \
 rustup update stable && \
 sudo apt-get install -y cmake pkg-config libfreetype6-dev libfontconfig1-dev libxcb-xfixes0-dev && \
 cargo build --release && \
 infocmp alacritty && \
 echo "source $(pwd)/extra/completions/alacritty.bash" >> ~/.bashrc && \
 source ~/.bashrc

Themes

These dotfiles include a set-theme script that you can run from your terminal to set your theme to any of the themes listed below. This script takes care of configuring your terminal, tmux, Vim and FZF's colors in 1 command.

If you don't like the included themes that's no problem. You can use whatever you want, there's no limitations. You could choose to manually change the colors or adjust the set-theme script

Ater installing these dotfiles you can run this from your terminal:

# Switch to a supported theme.
# Theme names are listed below near the screenshots.
# You can also run set-theme --help to see a list of themes.
set-theme [theme_name]

# Switch between dark and light backgrounds for the active theme.
set-theme --toggle-bg

# Switch the theme and toggle the background in 1 command.
set-theme [theme_name] --toggle-bg

How to add custom themes to the set-theme script?

Prefer a video? Here's a video that demonstrates performing the steps below.

After installing these dotfiles you'll have a ~/.local/bin/set-theme script. It's a zero dependency Python 3 script.

Open the above file
Check out the THEMES dictionary near the top of the file
Copy one of the existing themes' dictionary items, such as gruvbox
Rename the dictionary's key to whatever your new theme's colorscheme name is in Vim
Adjust all of the colors and additional values in your new dictionary item as you see fit
Run set-theme cooltheme, replacing cooltheme with whatever name you used in step 4

Your terminal and tmux colors will update automatically, but if you have Vim already open you'll need to manually run this command from within Vim to reload your config :so ~/.config/nvim/init.vim.

If you added a theme with good contrast ratios please open a pull request to get it added to the script.

How to use a different terminal in the set-theme script?

I'm using the Microsoft Terminal but if you're using something else then your terminal's colors won't get updated by this script because the script looks for strings that are in MS terminal's config, but it's not painful to change.

By the way, if you're using the Microsoft Terminal Preview edition you'll still need to do step 1 below because the path of your MS terminal config file will be different than the non-preview edition.

You'll want to adjust the set-theme script by doing this:

Change the TERMINAL_CONFIG variable to reference your terminal config's path
Change the terminal attributes in the THEMES dictionary to use your terminal's config option names
Change the regex in the change_terminal_theme function based on your terminal's config option formatting rules
Optionally install Gruvbox, One or any other themes (the MS Terminal config in this repo includes them)

FAQ

How to personalize these dotfiles?

Chances are you'll want to personalize some of these files, such as various Vim settings. Since this is a git repo you can always do a git pull to get the most up to date copy of these dotfiles, but then you may find yourself clobbering over your own personal changes.

Since we're using git here, we have a few reasonable options.

For example, from within this dotfiles git repo you can run git checkout -b personalized and now you are free to make whatever changes that you want on your custom branch. When it comes time to pull down future updates you can run a git pull origin master and then git rebase master to integrate any updates into your branch.

Another option is to fork this repo and use that, then periodically pull and merge updates. It's really up to you.

How to fix Vim taking a long time to open when inside of WSL?

It primarily comes down to either VcXsrv not running or a firewall tool blocking access to VcXsrv and it takes a bit of time for the connection to time out.

You can verify this by starting Vim with vim -X instead of vim. This will prevent Vim from connecting to an X server. This also means clipboard sharing to your system clipboard won't work, but it's good for a test.

Vim will try to connect to that X server by default because DISPLAY is exported in the .bashrc file. Installing and configuring VcXsrv as per these dotfiles will fix that issue.

If it still persists, it might be a software firewall issue. You can open TCP port 6000 and also restrict access to it from only WSL 2. This will depend on which tool you're using to configure that but that should do the trick.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

dotfiles & credit

Quickly Get Set Up with These Dotfiles

OS / distro specific installation steps

Debian

Ubuntu 20.04 LTS

Other Linux distros

macOS

Installing everything else (OS neutral)

Install these dotfiles and various tools on your system

Install ranger (better filesystem browser for ubuntu)

Install neovim (optional) - this is my typescript + LSP vim setup

Install plugins for tmux

Optionally confirm that a few things work after closing and re-opening your terminal

Extra WSL 1 and WSL 2 steps

Install alacritty (optional)

Themes

How to add custom themes to the set-theme script?

How to use a different terminal in the set-theme script?

FAQ

How to personalize these dotfiles?

How to fix Vim taking a long time to open when inside of WSL?

About

Releases

Packages

Contributors 3

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 265 Commits
.githooks		.githooks
.local/bin		.local/bin
.ssh		.ssh
.zsh_functions		.zsh_functions
c/Users/alexa		c/Users/alexa
etc		etc
zsh-completions		zsh-completions
.alacritty.yml		.alacritty.yml
.aliases		.aliases
.bashrc		.bashrc
.gemrc		.gemrc
.gitconfig		.gitconfig
.gitconfig.user		.gitconfig.user
.gitignore		.gitignore
.gitignore_global		.gitignore_global
.gitmux.conf		.gitmux.conf
.inputrc		.inputrc
.profile		.profile
.tmux.conf		.tmux.conf
.zshrc		.zshrc
.zshrc.zni		.zshrc.zni
LICENSE		LICENSE
README.md		README.md

License

alexmk92/dotfiles

Folders and files

Latest commit

History

Repository files navigation

dotfiles & credit

Quickly Get Set Up with These Dotfiles

OS / distro specific installation steps

Debian

Ubuntu 20.04 LTS

Other Linux distros

macOS

Installing everything else (OS neutral)

Install these dotfiles and various tools on your system

Install ranger (better filesystem browser for ubuntu)

Install neovim (optional) - this is my typescript + LSP vim setup

Install plugins for tmux

Optionally confirm that a few things work after closing and re-opening your terminal

Extra WSL 1 and WSL 2 steps

Install alacritty (optional)

Themes

How to add custom themes to the set-theme script?

How to use a different terminal in the set-theme script?

FAQ

How to personalize these dotfiles?

How to fix Vim taking a long time to open when inside of WSL?

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 3

Languages

Packages