duck-zsh

duck-zsh is my personal Zsh configuration.

Table of Contents

• Getting Started
  • Requirements
  • Installation
• Plugins
• Utilities
  • Screenshots

Getting Started

This section will guide you through installing duck-zsh.

Requirements

• oh-my-zsh manages your Zsh configuration.
• fzf is required for custom Zsh functions.

Installation

After you have met the requirements, proceed to following the installation steps.

1. Clone the repository using the following command:

# Make .config directory if your system doesn't already have one
mkdir -p $HOME/.config

# Remove the existing Zsh configuration
rm -rf $HOME/.config/zsh

# Clone my repo
git clone https://github.com/DuckyShine004/duck-zsh.git $HOME/.config/zsh

Warning

If you already have a Zsh setup, make sure to back it up before proceeding further.

2. After cloning the repository, run the install.sh script:

# Go into Zsh directory
cd $HOME/.config/zsh

# Grant the installation script executable permissions
chmod +x install.sh

# Run the installation script
./install.sh

3. Create symlinks for Zsh configuration files:

ln -s $HOME/.config/zsh $HOME/.zshenv

ln -s $HOME/.config/zsh $HOME/.zprofile

ln -s $HOME/.config/zsh $HOME/.zshrc

4. Finally, source the configuration:

source $HOME/.zshrc

Note

If sourcing fails, it's likely due to missing dependencies (e.g., pyenv) . Install the required packages and re-source the configuration.

Plugins

These are the plugins I use for my Zsh configuration:

• zsh-autosuggestions
• zsh-vi-mode
• zsh-syntax-highlighting

Utilities

Custom functions:

• find-file: Recursively search through files.
• find-directory: Terminal file explorer.
• nvims: Launch different Neovim configurations (you need to configure this yourself!)
• workspace-add: Add a new workspace.
• workspace-open: Open an existing workspace.

Important

You must have fzf for these custom functions to work!

Screenshots

Find File

Search through files recursively using the find-file command:

Find Directory

Navigate through your file system using the find-directory command:

Launch Neovim Configuration

Launch an existing Neovim configuration using the nvims command:

Open Workspace

Open an existing workspace using the workspace-open command: