zsh-win

zsh-theme on windows

OTHER License

Downloads
108
Stars
5
Committers
2

zsh-win



Table of Contents

🤓 Installation

  • Prerequisites

    • Git Bash: A command-line interface for Windows that provides a Unix-like shell.
    • Node.js: A JavaScript runtime that allows you to run and install npm packages.

To avoid issue

  1. Downloads these four .ttf files:

  2. Double-click on each file and click "Install". This will make MesloLGS NF font available to all applications on your system.

Visual Studio Code: Open File → Preferences → Settings (PC) or Code → Preferences → Settings (Mac), enter terminal.integrated.fontFamily in the search box at the top of the Settings tab, and set the value to MesloLGS NF. Consult this screenshot to see how it should look, or see this issue for more information.


Step #1

⚠️ IMPORTANT: Don't skip this step.

Run git bash as admin

  • Press:
    Windows +
    Key
    Git Bash
    Run as Administrator
  • Above instruction is not working goto issue git bash is not opening as admin on windows.

Step #2

  1. Install from NPM
npm i zsh-win # after installation
# type zsh-win on git bash to see the magic 🪄.
zsh-win
  1. From source code
  git clone https://github.com/w3cdpass/zsh-win.git
  cd zsh-win
  npm i
  node js/index.cjs

Note: Run the git bash as admin to install from source code

Step #3

    • Choose theme between them.
    • ❤️ Custom is great. If any issue with custom reffer this issue.

Step #4⚡

🪄 After installation type zsh-win to see the magic in git bash

Welcome to Customization

  • Example #1 🥱

    vim ~/.zshrc 
    
    • Search for ZSH_THEME="agnoster" .
    • Change the value ZSH_THEME="cloud" and save it .
    • Type zsh on git bash to activate theme .

    Note: You can select any zsh theme from ohmyzshthemes .

  • Example #2 😎🔥

    • Wants to use another seprate zsh theme that is not in ~/.oh-my-zsh.

    Like powerlevel10k and more


    # powelevel10k
    # use this cmd in git bash
    git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k
    # ZSH_THEME="powerlevel10k/powerlevel10k"
    sed -i.bak -e '/^ZSH_THEME=/c\ZSH_THEME="powerlevel10k/powerlevel10k"' -e '/source ~\/powerlevel10k\/powerlevel10k.zsh-theme/s|source ~/|source ~/.oh-my-zsh/custom/themes/|' ~/.zshrc && echo 'source ~/.oh-my-zsh/custom/themes/powerlevel10k/powerlevel10k.zsh-theme' >> ~/.zshrc && echo '[[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh' >> ~/.zshrc && zsh
    
    
    • Then type p10k configure or zsh . to use it

      For Instance: Add custom themes in ./oh-my-zsh/custom/themes folder with theme.zsh-theme .

The issue title

ISSUE #1

Git bash is not opening as admin in windows .

Try Manually

  • Tested on Windows 11

  • Open Command Pormpt .

  • Type ctrl + , go to setting .

  • Click the Git bash profile .

  • Check the button Run this profile as Administrator .

ISSUE #2

Zsh command not found .

Try Manually

  • Download the both .exe files from source code .

  • Paste these .exe in C:/Program Files/Git/usr/bin , Where Git is installed .

ISSUE #3

Icon/Symbols are missing.

  • Follow these steps .

  • Before you start, install those .ttf on you system

  • Then Restart your IDe .

  • After installation

    Refreance: Still doesn't work follow this link .

ISSUE #4

Custom zsh-theme is not working .

  • All custom themes of Zsh are in ~/.oh-my-zsh/custom/themes .
  • Replace custom custom.zsh-theme to your zsh theme .
  • Then change the value ZSH_THEME="custom" in .zshrc .

Contributors 🤗

w3cdpass Kupasva genrator-lgtm pard901

How to Contribute

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Create a new Pull Request
Package Rankings
Top 31.84% on Npmjs.org
Badges
Extracted from project README
npm GitHub stars npm version