Kaweees/zsh

๐Ÿ–ฅ๏ธ My custom configurations for zsh (Z shell) with an emphasis on speed and an efficient display of information

โ˜… 0Forks 0ShellGitHub โ†—Compare

Project website โ†—

debiandotfileszsh

README

Contributors Forks Stargazers

ZSH Logo

My custom configurations for zsh (Z shell) with an emphasis on speed and an efficient display of information

Built With

Python GitHub Actions Docker

Getting Started

Prerequisites

Before attempting to build this project, make sure you have git, zsh, and direnv installed on your machine.

Installation

To get a local copy of the project up and running on your machine, follow these simple steps:

  1. Install the dependencies

    sudo apt install -y zsh stow direnv fzf tmux libnotify-bin zoxide vim neovim gh git git-lfs
  2. Clone the project repository

    git clone https://github.com/Kaweees/zsh.git ~/zsh
    cd ~/zsh
  3. Install the Gitstatus extension

    git clone --depth=1 https://github.com/romkatv/gitstatus.git ~/gitstatus
  4. Set zsh as default shell

    sudo chsh -s $(which zsh)

    Alternatively, edit /etc/passwd directly:

    sudo vim /etc/passwd

    Find your user line and change the shell at the end from /bin/bash to /usr/bin/zsh.

  5. Stow the dotfiles

    stow -t ~ .
  6. Verify the installation

    getent passwd $USER # The last field should show zsh
  7. Log out and log back in to apply the changes and verify the installation.

    echo $0 # Should show zsh or -zsh

Project Structure

.zsh/
โ”œโ”€โ”€ .zshrc                          - ZSH configuration
โ”œโ”€โ”€ aliases.zsh                     - Program aliases
โ”œโ”€โ”€ functions.zsh                   - Functions
โ”œโ”€โ”€ keybinds.zsh                    - Keybinds
โ”œโ”€โ”€ plugins.zsh                     - Zinit plugins
โ”œโ”€โ”€ prompt.zsh                      - Shell prompt
โ”œโ”€โ”€ LICENSE                         - Project license
โ””โ”€โ”€ README.md                       - You are here

License

The source code for this project is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See LICENSE for details and more information.

Contributors

Kaweees

Issues