Zsh config

Basic Zsh config, using Prezto framework, Starship prompt and some extra modules.

The prompt theme is based on Nerd Font Symbols Preset. The FiraCode Nerd Font is included, update the terminal app preferences to use it, otherwise the special icons/glyphs won't be displayed.

Installation

Choose a folder (e.g.: ~/.zsh) and clone the repository:

git clone https://github.com/lucasng-dev/zsh-config.git ~/.zsh

Run the installer:

zsh ~/.zsh/install.zsh

The install process will update the ~/.zshenv file, pointing to this project. Reopen the terminal and adjust the font preferences.

Update

Use the following command/alias:

@zshup

An alternative is to run manually a git pull on this project folder and re-run the install.zsh script.

Uninstall

Update the ~/.zshenv file to remove the line that points to this project.

Update the terminal app preferences to use a normal font.

Delete the following folders:

• ~/.zsh (folder where the project was cloned)
• ~/.local/share/fonts/NerdFonts/FiraCode (patched font on Linux)
• ~/Library/Fonts/NerdFonts/FiraCode (patched font on macOS)

Custom config files

These local user home files, if existent, will be loaded in the following order:

User config file	Usage	Loaded on
~/.zshenv	Setup only, points to this project, keep it as is	All executions
~/.profile	Use ~/.zprofile instead	All executions
~/.zprofile ✅	Recommended, e.g: environment variables and options	All executions
~/.zshrc ✅	Recommended, e.g: aliases, functions	Interactive shell only
~/.zprestorc	If necessary, allows changes on Prezto config	Interactive shell only
~/.zlogin	Unusual, interactive shell, after open	Interactive shell only
~/.zlogout	Unusual, interactive shell, before exit	Interactive shell only

Extra config files used by modules

User config file	Usage	Loaded on
~/.host	Script to provision host	@host upgrade
~/.box	Script to provision distrobox	@box upgrade