Skip to content

Latest commit

 

History

History
298 lines (219 loc) · 7.6 KB

terminal-zsh-setup.md

File metadata and controls

298 lines (219 loc) · 7.6 KB
Raw

Zsh Terminal

Zsh

The Z shell (Zsh) is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting.

Zsh is an extended Bourne shell with many improvements, including some features of Bash, Korn shell (ksh), and tcsh.

Terminal theme - Oh My Zsh + Powerlevel10k + Nerd font

The standard macOS Terminal appearance is just boring. Apple included a few nice preset themes too, but to really make your terminal appearance stand out you need to customize it yourself.

Below is the Terminal using my personal theme and .zshrc configuration. Feel free to copy and use it.

You can set up Zsh following this tutorial or using the mac-setup install script:

bash <(curl -fsSL raw.githubusercontent.com/borgesnotes/mac-setup/master/install) zsh

macOS Zsh theme

Update and select Zsh as the default shell

  1. Define HOMEBREW_PREFIX

    if [[ "$(/usr/bin/uname -m)" == "arm64" ]]; then
    HOMEBREW_PREFIX="/opt/homebrew"
else
    HOMEBREW_PREFIX="/usr/local"
fi

eval "$(${HOMEBREW_PREFIX}/bin/brew shellenv)"

  2. Update zsh:

    brew install zsh

  3. Add the new shell to the list of allowed shells:

    if $(grep -Fxq "${HOMEBREW_PREFIX}/bin/zsh" /etc/shells); then
    echo "The list of shells is already updated"
else
    echo "${HOMEBREW_PREFIX}/bin/zsh" | sudo tee -a /etc/shells
fi

  4. Change to the new shell:

    chsh -s ${HOMEBREW_PREFIX}/bin/zsh

  5. Check the ZSH version:

    zsh --version

Install Oh My Zsh

Oh My Zsh is an open source, community-driven framework for managing your zsh configuration.

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

You can upgrade it to get the latest features it offers:

omz update

Install Fonts

You will want to check out the Nerd-Fonts repo, which contains a ton of fonts which support all the awesome symbols you want to use.

To install the fonts, use Homebrew Cask Fonts:

  1. Add Homebrew Cask Fonts:

    brew tap homebrew/cask-fonts

  2. Install Nerd Font:

    brew install font-hack-nerd-font

Install Powerlevel10k theme

Powerlevel10k is the most awesome Powerline theme for ZSH around!

Run on the terminal:

URL="https://github.com/romkatv/powerlevel10k.git"
DIR="${HOME}/.oh-my-zsh/custom/themes/powerlevel10k"
git clone "${URL}" "${DIR}"

Install Plugins

Install zsh-autosuggestions

Clone the repository inside your oh-my-zsh repo:

URL="https://github.com/zsh-users/zsh-autosuggestions"
DIR="${HOME}/.oh-my-zsh/custom/plugins/zsh-autosuggestions"
git clone "${URL}" "${DIR}"

Install syntax highlighting

Syntax highlighting package provides syntax highlighting for the shell zsh.

Clone the repository inside your oh-my-zsh repo:

URL="https://github.com/zsh-users/zsh-syntax-highlighting.git"
DIR="${ZSH_CUSTOM:-${HOME}/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting"
git clone "${URL}" "${DIR}"

Keep script compatibility with GNU Linux (optional)

brew install coreutils
brew install findutils
brew install gnu-tar
brew install gnu-sed

Update .zshrc

  1. Backup the current .zshrc file:

    if [[ -f "${HOME}/.zshrc" ]]; then
    cp "${HOME}/.zshrc" "${HOME}/.zshrc.bkp"
fi

  2. Update the .zshrc. Paste that in the terminal:

    read -r -d '' ZSH_PROFILE <<"EOF"
# Zsh Profile for macOS
# Copyright (c) Marcos Gomes Borges
# https://github.com/borgesnotes/mac-setup

# Homebrew
if [[ "$(/usr/bin/uname -m)" == "arm64" ]]; then
    HOMEBREW_PREFIX="/opt/homebrew"
else
    HOMEBREW_PREFIX="/usr/local"
fi

eval "$(${HOMEBREW_PREFIX}/bin/brew shellenv)"

# POWERLEVEL 10K THEME SETTINGS
############################################################
POWERLEVEL9K_MODE="nerdfont-complete"

# Current directory
POWERLEVEL9K_DIR_FOREGROUND=254
POWERLEVEL9K_DIR_BACKGROUND=237

# OS identifier color
POWERLEVEL9K_OS_ICON_FOREGROUND=232
POWERLEVEL9K_OS_ICON_BACKGROUND=7

# Time
POWERLEVEL9K_TIME_FOREGROUND=0
POWERLEVEL9K_TIME_BACKGROUND=7
POWERLEVEL9K_TIME_FORMAT="%D{%d/%m %H:%M:%S}"

# Current Python virtual environment
POWERLEVEL9K_VIRTUALENV_FOREGROUND=0
POWERLEVEL9K_VIRTUALENV_BACKGROUND=220

# Pyenv
POWERLEVEL9K_PYENV_FOREGROUND=255
POWERLEVEL9K_PYENV_BACKGROUND=24

POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(
    os_icon
    dir
    vcs
    status
    command_execution_time
    background_jobs
    direnv
    asdf
    virtualenv
    pyenv
    vim_shell
    newline
    prompt_char
)
POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(
    newline
)

# OH MY ZSH SETTINGS
############################################################
# Path to oh-my-zsh installation
export ZSH="${HOME}/.oh-my-zsh"

# ZSH Terminal title
DISABLE_AUTO_TITLE=true

# Set name of the theme to load
ZSH_THEME="powerlevel10k/powerlevel10k"

# Plugins
plugins=(
    git
    gitfast
    python
    pip
    pipenv
    virtualenv
    docker
    docker-compose
    kubectl
    colorize
    compleat
    zsh-autosuggestions
    zsh-syntax-highlighting
    colored-man-pages
    command-not-found
)

# Fix slowness of copy & paste with zsh-syntax-highlighting
# https://gist.github.com/magicdude4eva/2d4748f8ef3e6bf7b1591964c201c1ab
zstyle ':bracketed-paste-magic' active-widgets '.self-*'

# Update ZSH settings
source $ZSH/oh-my-zsh.sh

# User configuration
############################################################

# Python virtual environment
# Allow pip only for active virtual environment
# Use 'gpip' for global environment
export PIP_REQUIRE_VIRTUALENV=true
gpip(){
    PIP_REQUIRE_VIRTUALENV="" pip "${@}"
}

# Pyenv Python version management
if type pyenv 1>/dev/null 2>&1; then
    eval "$(pyenv init --path)"
    eval "$(pyenv init -)"
    pyenv virtualenvwrapper
fi

# Keep compatible with GNU Linux
export PATH="${HOMEBREW_PREFIX}/opt/coreutils/libexec/gnubin:$PATH"
export PATH="${HOMEBREW_PREFIX}/opt/findutils/libexec/gnubin:$PATH"
export PATH="${HOMEBREW_PREFIX}/opt/gnu-tar/libexec/gnubin:$PATH"
export PATH="${HOMEBREW_PREFIX}/opt/gnu-sed/libexec/gnubin:$PATH"
EOF

echo "${ZSH_PROFILE}" > "${HOME}/.zshrc"

Enable Antialias text, Bold Fonts, ANSI Colors, and Bright Colors

  1. Open the macOS Terminal

  2. In the top menu bar, select Terminal then Preferences... (⌘,)

  3. Select the Profiles tab

  4. Choose the Basic or Pro profile/theme from the left side list

  5. Press the Default button near the bottom of the window

  6. Under the Font tab change the font:

    • Hack Regular Nerd Font Complete 18 pt

  7. Under the Text tab check the boxes:

    • Antialias text
    • Use bold fonts
    • Display ANSI colors
    • Use bright colors for bold text

  8. Update the ANSI Colours table: click on the colour, select the colour picker tool and use the colours from the palette below as a reference.

Terminal Profiles - Text