zsh 配置

zsh 相关配置和好用的插件、主题

zsh 配置文件

zsh 的配置文件用于定制和配置 shell 的行为，根据存放的目录和使用场景，有以下配置文件

系统范围的配置文件

系统范围的配置文件，对所有用户都生效

1. /etc/zshenv
   • 执行时机： 在每次 zsh 启动时都会执行
   • 用途： 用于设置全局环境变量
2. /etc/zshrc
   • 执行时机： 在每次交互式启动 zsh 时被执行
   • 用途： 用于配置终端外观、添加别名、定义函数等
3. /etc/zlogin
   • 执行时机： 在用户登录时（非交互式）被执行
   • 用途： 用于设置登录时的全局行为，如显示系统信息等
4. /etc/zlogout
   • 执行时机： 在用户注销时被执行
   • 用途： 用于设置注销时的全局行为

用户级别的配置文件

用户级别的配置文件，对每个用户都生效，可以通过 echo $ZDOTDIR 命令查看当前用户的配置文件存放目录

1. ~/.zshenv
   • 执行时机： 在每次 zsh 启动时都会执行
   • 用途： 用于设置用户特定的环境变量和个人偏好设置
2. ~/.zshrc (推荐使用的配置文件)
   • 执行时机： 在每次交互式启动 zsh 时被执行
   • 用途： 用户可以在这里定制个人的 shell 环境，例如添加个人别名、自定义提示符等
3. ~/.zlogin
   • 执行时机： 在用户登录时（非交互式）被执行
   • 用途： 用户可以在这里添加个人登录时需要执行的命令
4. ~/.zlogout
   • 执行时机： 在用户注销时被执行
   • 用途： 用户可以在这里添加个人注销时需要执行的命令

配置文件的执行顺序

从上到下，从左到右执行

系统范围的配置文件	用户级别的配置文件	Login Shell	Interactive Shell	Scripts	Terminal.app
/etc/zshenv	~/.zshenv	✅	✅	✅	✅
/etc/zshrc	~/.zshrc	❌	✅	❌	✅
/etc/zlogin	~/.zlogin	✅	❌	❌	✅
/etc/zlogout	~/.zlogout	✅	❌	❌	✅

oh-my-zsh

用于自定义 zsh 的配置

1. 主题配置
2. 插件安装

安装

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
# OR 国内镜像
sh -c "$(curl -fsSL https://gitee.com/mirrors/oh-my-zsh/raw/master/tools/install.sh)"

更新

omz update

Oh My Zsh | Github

zsh 插件

autojump

用于常用目录间的快速跳转（通过维护命令行中最常用的目录的数据库来工作）

安装

# 推荐
brew install autojump

# OR
git clone --depth=1 git://github.com/joelthelion/autojump.git

cd autojump

./install.py or ./uninstall.py

autojump | Github

z

和 autojump 功能一致，是 oh-my-zsh 内置插件

# 在 ~/.zshrc 中配置
plugins=(其他插件 z)

# 使配置生效
source ~/.zshrc

z | Github

fast-syntax-highlighting

终端语法高亮显示

安装

# clone
git clone --depth=1 https://github.com/zdharma-continuum/fast-syntax-highlighting.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/fast-syntax-highlighting

# 在 ~/.zshrc 中配置(在 plugins 的最后面加上 fast-syntax-highlighting)
plugins=(其他插件 fast-syntax-highlighting)

# 使配置生效
source ~/.zshrc

Fast Syntax Highlighting | Github

zsh-autosuggestions

根据您的历史记录和完成情况建议您键入的命令

安装

# clone
git clone --depth=1 git://github.com/zsh-users/zsh-autosuggestions $ZSH_CUSTOM/plugins/zsh-autosuggestions

# 在 ~/.zshrc 中配置
plugins=(其他插件 zsh-autosuggestions)

# 使配置生效
source ~/.zshrc

zsh-autosuggestions | Github

zsh 主题

powerlevel10k

安装

git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k

# 在 ~/.zshrc 中配置
ZSH_THEME="powerlevel10k/powerlevel10k"

# 使配置生效
source ~/.zshrc

配置

使用 iTerm2 可自动安装所需字体

p10k configure

修复 vscode 终端图标乱码，修改 terminal.integrated.fontFamily 为 "MesloLGS NF"

"terminal.integrated.fontFamily": "MesloLGS NF",

更新

git -C ${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k pull

查看当前配置使用的图标

get_icon_names

自定义配置

# 打开 p10k 配置文件
code ~/.p10k.zsh

# 修改 POWERLEVEL9K_LEFT_PROMPT_ELEMENTS 和 POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS 的配置
# 比如显示当前使用的 node 版本

# 使配置生效
source ~/.zshrc

Powerlevel10k | Github

常用配置

# 主题
ZSH_THEME="powerlevel10k/powerlevel10k"

# 历史命令显示时间
HIST_STAMPS="yyyy-mm-dd"

# 插件配置
plugins=(git autojump vscode brew node npm yarn web-search zsh-autosuggestions fast-syntax-highlighting)

# 常用别名
alias p="pnpm"
alias pnpx="pnpm dlx"
alias d="yarn dev"
alias s="yarn start"
alias b="yarn build"
alias t="yarn test"

alias glogp="git log --pretty='%C(yellow)%h%C(reset) %ad %C(green)%s%C(reset) %C(red)%d%C(reset) %C(bold blue)[%an]%C(reset)'"

alias cat="bat"

# 代理相关
proxy() {
  http="http://127.0.0.1:1087"
  socks5="socks5://127.0.0.1:1086"

  # 只代理 http 请求
  export http_proxy=$http
  export HTTP_PROXY=$http

  # 只代理 https 请求
  export https_proxy=$http
  export HTTPS_PROXY=$http

  # 代理所有请求
  export all_proxy=$socks5
  export ALL_PROXY=$socks5

  echo "\033[32m已开启终端代理\033[0m"
}

unproxy() {
  unset http_proxy HTTP_PROXY https_proxy HTTPS_PROXY all_proxy ALL_PROXY
  echo "\033[32m已关闭终端代理\033[0m"
}

# 复制当前项目名和分支名（方便提测）
c() {
  if [[ -d .git ]]; then
    local data="项目名: $(basename $PWD)\n分支名: $(git_current_branch)"

    if echo -n $data | pbcopy; then
      echo -e "$data\n\033[32m复制成功\033[0m"
    else
      echo -e "$data\n\033[33m复制失败，请检查 pbcopy 是否可用\033[0m"
    fi

  else
    echo "\033[33m当前目录不存在 .git 配置\033[0m"
  fi
}

# 修改 github 用户名和邮箱地址（防止造成用公司信息提交到 github 的尴尬）
if [[ -d .git ]]; then
  local githubName="maomao"                 # github 用户名
  local githubEmail="1714487678@qq.com"     # github 邮箱地址
  local url=$(git remote get-url origin)
  local localName=$(git config user.name)
  local localEmail=$(git config user.email)
  # 只判断 github 仓库，根据需要修改（判断字符建议写长点）
  if [[ $url =~ "github.com/maomao1996" ]]; then
    # 提示当前为 github 项目（不需要就注释）
    echo -e "\033[34m当前为 github 项目\033[0m"
    if [[ $githubName && $githubName != $localName ]]; then
      $(git config user.name "$githubName")
      echo -e "已将当前仓库的 name 从\033[33m $localName \033[0m修改为\033[32m $githubName \033[0m"
    fi
    if [[ $githubEmail && $githubEmail != $localEmail ]]; then
      $(git config user.email "$githubEmail")
      echo -e "已将当前仓库的 email 从\033[33m $localEmail \033[0m修改为\033[32m $githubEmail \033[0m"
    fi
  fi
fi

代理相关说明

同时设置大小写的环境变量来保证兼容性（因为有的应用读取的是大写的环境变量，而有的应用读取的是小写的环境变量）