Gentleman.Dots

Description

This repository contains customized configurations for a complete development environment, including:

• Neovim
• Fish
• Zsh
• Nushell
• Tmux
• Zellij
• Terminal emulators:
  • Alacritty
  • WezTerm
  • Kitty

You can choose between automatic and manual installation methods depending on your preference and operating system.

Important: Windows users must follow the manual installation instructions before running the script.

Installation (Automatic Recommended!)

The Easy Way! Test the automated process and let the script do all the work for you 😘

The automatic installation script is the quickest and easiest way to set up your development environment. This script handles all the heavy lifting, but remember that you must install the font mentioned below before running it. The script is designed for macOS, Linux, and WSL systems. If you’re on Windows, you’ll need to follow the manual steps first before attempting to run this script.

curl -O https://raw.githubusercontent.com/Gentleman-Programming/Gentleman.Dots/refs/heads/main/install-linux-mac.sh

sudo chmod +x install-linux-mac.sh
bash ./install-linux-mac.sh

Manual Installation

Welcome to the Gentleman.Dots manual configuration guide! This document will walk you through the steps required to set up your development environment.

Clone the repo before continuing!!!

git clone git@github.com:Gentleman-Programming/Gentleman.Dots.git
cd Gentleman.Dots

---

For Windows

Important: Windows users must follow these manual installation steps before running the automated script.

1. Install WSL

WSL (Windows Subsystem for Linux) allows you to run Linux on Windows. Install it and set it to version 2:

wsl --install
wsl --set-default-version 2

2. Install a Linux Distribution

Install a Linux distribution (e.g., Ubuntu) in WSL:

wsl --install -d Ubuntu

To list available distributions:

wsl --list --online

Install your preferred distribution:

wsl --install -d <distribution-name>

3. Installing the Iosevka Font

The Iosevka Term Nerd Font is required for terminal emulators in this setup. On Windows, this installation must be done manually.

1. Download the Iosevka font from its official site or from Nerd Fonts GitHub.
2. Extract the archive and locate the font files (.ttf or .otf).
3. Install the fonts:
   • Right-click each font file and select "Install for all users" to install the font system-wide.

4. Launch and Configure the Distribution

Open the installed distribution to complete setup. Update it with:

sudo apt-get update
sudo apt-get upgrade

5. Install a Terminal Emulator

Choose and install one of the following terminal emulators:

• Alacritty: Download from GitHub Releases and place alacritty.exe in your PATH.
• WezTerm: Download and Install and create an environment variable called HOME that resolves to C:\Users\your-username.
• Kitty: Download and Install.

6. Configuration Transfer for Terminal Emulators

Using PowerShell:

Alacritty Configuration

mkdir $env:APPDATA\alacritty
Copy-Item -Path alacritty.toml -Destination $env:APPDATA\alacritty\alacritty.toml

# In alacritty.toml, uncomment and set the shell program to WSL:

#[shell]
#program = "wsl.exe"
#args = ["--cd", "~"]

WezTerm Configuration

Copy-Item -Path .wezterm.lua -Destination $HOME

# Uncomment for Windows settings in .wezterm.lua:

# config.default_domain = 'WSL:Ubuntu'
# config.front_end = "WebGpu"
# config.max_fps = 120

If WezTerm doesn't take the initial configuration:

• Create a wezterm folder in C:\Users\your-username\.config
• Copy .wezterm.lua into wezterm.lua inside that directory
• Restart WezTerm

Kitty Configuration

Copy-Item -Path GentlemanKitty\* -Destination $HOME\.config\kitty -Recurse

7. Install Chocolatey and win32yank

Chocolatey is a package manager for Windows that simplifies the installation of software.

To install Chocolatey:

• Open PowerShell as an administrator.
• Run the following command:

Set-ExecutionPolicy Bypass -Scope Process -Force; `
[System.Net.ServicePointManager]::SecurityProtocol = `
[System.Net.ServicePointManager]::SecurityProtocol -bor 3072; `
iwr https://community.chocolatey.org/install.ps1 -UseBasicParsing | iex

To install win32yank:

• After installing Chocolatey, run:

choco install win32yank

Note: win32yank is required for clipboard integration in Neovim when using WSL.

---

For Linux, Arch Linux, macOS, and WSL

Prerequisites

• macOS or Linux: Ensure you have one of these operating systems.
• Administrator privileges (sudo): You'll need administrator access to install some tools.

1. Install Dependencies

Arch Linux

sudo pacman -Syu --noconfirm
sudo pacman -S --needed --noconfirm base-devel curl file git wget
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
. $HOME/.cargo/env

Linux

sudo apt-get update
sudo apt-get install -y build-essential curl file git
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
. $HOME/.cargo/env

Mac

xcode-select --install
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
. $HOME/.cargo/env

2. Install Iosevka Term Nerd Font (icons and font style)

Arch Linux / Linux

mkdir -p ~/.local/share/fonts
wget -O ~/.local/share/fonts/Iosevka.zip https://github.com/ryanoasis/nerd-fonts/releases/download/v3.3.0/IosevkaTerm.zip
unzip ~/.local/share/fonts/Iosevka.zip -d ~/.local/share/fonts/
fc-cache -fv

Mac

brew tap homebrew/cask-fonts
brew install --cask font-iosevka-term-nerd-font

3. Choose and Install Terminal Emulator

Alacritty

Arch Linux

sudo pacman -S --noconfirm alacritty
mkdir -p ~/.config/alacritty && cp alacritty.toml ~/.config/alacritty/alacritty.toml

Mac

brew install alacritty --cask
mkdir -p ~/.config/alacritty && cp alacritty.toml ~/.config/alacritty/alacritty.toml

Linux

sudo add-apt-repository ppa:aslatter/ppa; sudo apt update; sudo apt install alacritty
mkdir -p ~/.config/alacritty && cp alacritty.toml ~/.config/alacritty/alacritty.toml

WezTerm

Arch Linux

sudo pacman -S --noconfirm wezterm
mkdir -p ~/.config/wezterm && cp .wezterm.lua ~/.config/wezterm/wezterm.lua

Mac

brew install wezterm --cask
mkdir -p ~/.config/wezterm && cp .wezterm.lua ~/.config/wezterm/wezterm.lua

Linux

brew tap wez/wezterm-linuxbrew; brew install wezterm
mkdir -p ~/.config/wezterm && cp .wezterm.lua ~/.config/wezterm/wezterm.lua

Kitty

Mac

brew install --cask kitty
mkdir -p ~/.config/kitty && cp -r GentlemanKitty/* ~/.config/kitty

4. Choose and Install a Shell

Nushell

1. Step

cp -rf bash-env-json ~/.config/
cp -rf bash-env.nu ~/.config/
brew install nushell carapace zoxide atuin jq bash starship fzf
mkdir -p ~/.cache/starship
mkdir -p ~/.cache/carapace
mkdir -p ~/.local/share/atuin
cp -rf starship.toml ~/.config/

2. Step

Arch Linux / Linux

mkdir -p ~/.config/nushell
run_command "cp -rf GentlemanNushell/* ~/.config/nushell/"

Mac

mkdir -p ~/Library/Application\ Support/nushell

## udpate config to use mac
if grep -q "/home/linuxbrew/.linuxbrew/bin" GentlemanNushell/env.nu; then
  awk -v search="/home/linuxbrew/.linuxbrew/bin" -v replace="    | prepend '/opt/homebrew/bin'" '
  $0 ~ search {print replace; next}
  {print}
  ' GentlemanNushell/env.nu > GentlemanNushell/env.nu.tmp && mv GentlemanNushell/env.nu.tmp GentlemanNushell/env.nu
else
  echo "    | prepend '/opt/homebrew/bin'" >> GentlemanNushell/env.nu
fi

cp -rf GentlemanNushell/* ~/Library/Application\ Support/nushell/

Fish + Starship

brew install fish carapace zoxide atuin starship fzf
mkdir -p ~/.cache/starship
mkdir -p ~/.cache/carapace
mkdir -p ~/.local/share/atuin
cp -rf starship.toml ~/.config/
cp -rf GentlemanFish/fish ~/.config

Zsh + Power10k**

brew install zsh carapace zoxide atuin fzf
brew install zsh-autosuggestions zsh-syntax-highlighting zsh-autocomplete
mkdir -p ~/.cache/carapace
mkdir -p ~/.local/share/atuin
cp -rf GentlemanZsh/.zshrc ~/
cp -rf GentlemanZsh/.p10k.zsh ~/
cp -rf GentlemanZsh/.oh-my-zsh ~/
brew install powerlevel10k

5. Choose and Install Window Manager

Tmux

brew install tmux
git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
mkdir -p ~/.tmux
cp -r GentlemanTmux/.tmux/* ~/.tmux/
cp GentlemanTmux/.tmux.conf ~/
tmux new-session -d -s plugin-installation 'source ~/.tmux.conf; tmux run-shell ~/.tmux/plugins/tpm/bin/install_plugins'
tmux kill-session -t plugin-installation

Zellij

1. Step => Install Zellij

cargo install zellij
mkdir -p ~/.config/zellij
cp -r GentlemanZellij/zellij/* ~/.config/zellij/

2. Step => If you use ZSH

# update or replace TMUX
if grep -q "TMUX" ~/.zshrc; then
  awk -v search="TMUX" -v replace='WM_VAR="/$ZELLIJ"' '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.zshrc > ~/.zshrc.tmp && mv ~/.zshrc.tmp ~/.zshrc
else
  echo 'WM_VAR="/$ZELLIJ"' >> ~/.zshrc
fi

# update or replace tmux
if grep -q "tmux" ~/.zshrc; then
  awk -v search="tmux" -v replace='WM_CMD="zellij"' '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.zshrc > ~/.zshrc.tmp && mv ~/.zshrc.tmp ~/.zshrc
else
  echo 'WM_CMD="zellij"' >> ~/.zshrc
fi

3. Step => If you use Fish

if grep -q "TMUX" ~/.config/fish/config.fish; then
  awk -v search="TMUX" -v replace="if not set -q ZELLIJ" '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.config/fish/config.fish > ~/.config/fish/config.fish.tmp && mv ~/.config/fish/config.fish.tmp ~/.config/fish/config.fish
else
  echo "if not set -q ZELLIJ" >> ~/.config/fish/config.fish
fi

# update or replace tmux
if grep -q "tmux" ~/.config/fish/config.fish; then
  awk -v search="tmux" -v replace="zellij" '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.config/fish/config.fish > ~/.config/fish/config.fish.tmp && mv ~/.config/fish/config.fish.tmp ~/.config/fish/config.fish
else
  echo "zellij" >> ~/.config/fish/config.fish
fi

3. Step => If you use Nushell

Mac

# update or replace "tmux"
if grep -q '"tmux"' GentlemanNushell/config.nu; then
  awk -v search='"tmux"' -v replace='let MULTIPLEXER = "zellij"' '
  $0 ~ search {print replace; next}
  {print}
  ' GentlemanNushell/config.nu > GentlemanNushell/config.nu.tmp && mv GentlemanNushell/config.nu.tmp GentlemanNushell/config.nu
else
  echo 'let MULTIPLEXER = "zellij"' >> GentlemanNushell/config.nu
fi

# update or replace "TMUX"
if grep -q '"TMUX"' GentlemanNushell/config.nu; then
  awk -v search='"TMUX"' -v replace='let MULTIPLEXER_ENV_PREFIX = "ZELLIJ"' '
  $0 ~ search {print replace; next}
  {print}
  ' GentlemanNushell/config.nu > GentlemanNushell/config.nu.tmp && mv GentlemanNushell/config.nu.tmp GentlemanNushell/config.nu
else
  echo 'let MULTIPLEXER_ENV_PREFIX = "ZELLIJ"' >> GentlemanNushell/config.nu
fi

# copy files to nushell support directory
cp -rf GentlemanNushell/* ~/Library/Application\ Support/nushell/

Arch Linux / Linux

if grep -q '"tmux"' ~/.config/nushell/config.nu; then
  awk -v search='"tmux"' -v replace='let MULTIPLEXER = "zellij"' '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.config/nushell/config.nu > ~/.config/nushell/config.nu.tmp && mv ~/.config/nushell/config.nu.tmp ~/.config/nushell/config.nu
else
  echo 'let MULTIPLEXER = "zellij"' >> ~/.config/nushell/config.nu
fi

# update or replace "TMUX"
if grep -q '"TMUX"' ~/.config/nushell/config.nu; then
  awk -v search='"TMUX"' -v replace='let MULTIPLEXER_ENV_PREFIX = "ZELLIJ"' '
  $0 ~ search {print replace; next}
  {print}
  ' ~/.config/nushell/config.nu > ~/.config/nushell/config.nu.tmp && mv ~/.config/nushell/config.nu.tmp ~/.config/nushell/config.nu
else
  echo 'let MULTIPLEXER_ENV_PREFIX = "ZELLIJ"' >> ~/.config/nushell/config.nu
fi

6. Install NVIM

brew install nvim node npm git gcc fzf fd ripgrep coreutils bat curl lazygit
mkdir -p ~/.config/nvim
cp -r GentlemanNvim/nvim/* ~/.config/nvim/
# update or replace /your/notes/path
if grep -q "/your/notes/path" "$HOME/.config/nvim/lua/plugins/obsidian.lua"; then
  awk -v search="/your/notes/path" -v replace="path = '$OBSIDIAN_PATH'" '
  $0 ~ search {print replace; next}
  {print}
  ' "$obsidian_config_file" > "${obsidian_config_file}.tmp" && mv "${obsidian_config_file}.tmp" "$obsidian_config_file"
else
  echo "path = '$OBSIDIAN_PATH'" >> "$obsidian_config_file"
fi

• Manual Obsidian Configuration

  To set up your Obsidian vault path in Neovim:

  1. Create the directory for your Obsidian notes (replace /path/to/your/notes with your desired path):

     mkdir -p /path/to/your/notes

  2. Create a templates folder inside your notes directory:

     mkdir -p /path/to/your/notes/templates

  3. Edit the obsidian.lua file to configure the vault path:

     nvim ~/.config/nvim/lua/plugins/obsidian.lua

  4. Update the path setting in obsidian.lua:

     path = "/path/to/your/notes",

  5. Save and close the file.

7. Set Default Shell

1. Step

ZSH

shell_path=$(which "zsh")

*Fish

shell_path=$(which "fish")

Nushell

shell_path=$(which "nu")

2. Step => Execute to Replace Default Shell

if [ -n "$shell_path" ]; then
  # Add shell to /etc/shells if not already present
  sudo sh -c "grep -Fxq \"$shell_path\" /etc/shells || echo \"$shell_path\" >> /etc/shells"

  # Change the default shell for the user
  sudo chsh -s "$shell_path" "$USER"

  # Verify if the shell has been changed
  if [ "$SHELL" != "$shell_path" ]; then
    echo -e "${RED}Error: Shell did not change. Please check manually.${NC}"
    echo -e "${GREEN}Command: sudo chsh -s $shell_path \$USER ${NC}"
  else
    echo -e "${GREEN}Shell changed to $shell_path successfully.${NC}"
  fi
else
  echo -e "${RED}Shell $shell_choice not found.${NC}"
fi

# Execute the chosen shell
exec $shell_choice

8. Restart the Shell or Computer

• Close and reopen your terminal, or restart your computer or WSL instance for the changes to take effect.

---

You're done! You have manually configured your development environment following the Gentleman.Dots guide. Enjoy your new setup!

Note: If you encounter any problems during configuration, consult the official documentation of the tools or seek help online.

Happy coding!