Cover image for Setup guide for ZSH in GitHub codespaces

Setup guide for ZSH in GitHub codespaces

Guide on setting up ZSH in github with a few plugins in simple steps -

zshgithubcodespacesstarshipterminal

Setup ZSH

This post will guide you through to set up starship along with zsh suggestions and zsh syntax highlight for your codespaces.

Table of Contents

Setup Starship

This is an optional package if you want to beautify your terminal. Else you can also use any other ZSH themes.

Install starship

You cannot install starship in ZSH shell at the time of writing this. You can switch to bash.

curl -sS https://starship.rs/install.sh | sh

Setup the config in the ZSH file

echo "eval \"\$(starship init zsh)\"" >> ${ZSOTDIR:-$HOME}/.zshrc

Install ZSH Auto Suggestions

  1. Clone the repository
git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions

You can change the path to anything you want. Here we use ~/.zsh/zsh-autosuggestions

  1. Add the invoke script to the ZSH config
echo "source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh" >> ${ZSOTDIR:-$HOME}/.zshrc

Install ZSH Syntax Highlighting

  1. Clone the repository
git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ~/.zsh/zsh-syntax-highlighting
  1. Add the invoke script to the ZSH config
echo "source ~/.zsh/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" >> ${ZDOTDIR:-$HOME}/.zshrc

Note: If you see a Systemd in the terminal and want to remove it then follow the next command

mkdir -p ~/.config && printf "[container]\ndisabled = true" >> ~/.config/starship.toml

Voila! You are ready to use ZSH with Starship and ZSH Auto Suggestions and Syntax Highlighting.

If you like it consider following me on github