Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattmc3/zdotdir
My zsh config
https://github.com/mattmc3/zdotdir
dotfiles shell zsh
Last synced: 3 months ago
JSON representation
My zsh config
- Host: GitHub
- URL: https://github.com/mattmc3/zdotdir
- Owner: mattmc3
- License: mit
- Created: 2019-03-06T20:26:01.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T21:17:10.000Z (10 months ago)
- Last Synced: 2024-03-27T22:27:50.365Z (10 months ago)
- Topics: dotfiles, shell, zsh
- Language: Shell
- Homepage:
- Size: 2.25 MB
- Stars: 128
- Watchers: 6
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zdotdir
My `$ZDOTDIR` [dotfiles] directory, which contains my zsh configuration.
## My Terminal
![My Terminal][zdotdir_gif]
## My setup
I like my Zsh to behave like [Fish][fish], so there's a lot of features that will be very familiar to other Fish users.
- A functions directory for my custom functions
- A completions directory for my custom functions
- A conf.d directory so that .zshrc isn't a cluttered mess
- A plugins directory similar to [oh-my-zsh] for adding/removing shell features
## Installation
Since this is my personal `$ZDOTDIR`, this installation procedure is mostly for my personal use.
It's a good idea to backup existing files first:
```zsh
setopt extended_glob
zfiles=(
${ZDOTDIR:-~}/.zsh*(.N)
${ZDOTDIR:-~}/.zlog*(.N)
${ZDOTDIR:-~}/.zprofile(.N)
)
mkdir -p ~/.bak
for zfile in $zfiles; do
cp $zfile ~/.bak
done
unset zfile zfiles
```
Install this dotfiles repo to your `$ZDOTDIR`:
```zsh
# set the amazing ZDOTDIR variable
export ZDOTDIR=~/.config/zsh
# clone this repo
git clone --recursive [email protected]:mattmc3/zdotdir.git $ZDOTDIR
# change the root .zshenv file to use ZDOTDIR
cat << 'EOF' >| ~/.zshenv
export ZDOTDIR=~/.config/zsh
[[ -f $ZDOTDIR/.zshenv ]] && . $ZDOTDIR/.zshenv
EOF
# load zsh
zsh
```
## Performance
A snappy shell is very important. I regularly run [zsh-bench](https://github.com/romkatv/zsh-bench) to make sure my shell feels snappy.
The latest benchmark run shows that we load a new shell pretty fast.
```zsh
% # MacBook Air (M3, 2024): starship prompt
% zsh-bench
==> benchmarking login shell of user matt ...
creates_tty=0
has_compsys=1
has_syntax_highlighting=1
has_autosuggestions=1
has_git_prompt=1
first_prompt_lag_ms=130.800
first_command_lag_ms=139.313
command_lag_ms=126.693
input_lag_ms=11.314
exit_time_ms=65.501
% # MacBook Air (M3, 2024): p10k prompt
==> benchmarking login shell of user matt ...
creates_tty=0
has_compsys=1
has_syntax_highlighting=1
has_autosuggestions=1
has_git_prompt=1
first_prompt_lag_ms=13.365
first_command_lag_ms=125.555
command_lag_ms=47.757
input_lag_ms=8.953
exit_time_ms=70.038
```
If you prefer a naive, completely meaningless Zsh 'exit' benchmark, I include that too for legacy reasons.
```zsh
% # MacBook Air (M3, 2024)
% for i in {1..10}; do; /usr/bin/time zsh -lic exit; done
0.09 real 0.03 user 0.02 sys
0.07 real 0.02 user 0.01 sys
0.06 real 0.02 user 0.01 sys
0.07 real 0.02 user 0.01 sys
0.07 real 0.02 user 0.01 sys
0.06 real 0.02 user 0.01 sys
0.07 real 0.02 user 0.01 sys
0.07 real 0.02 user 0.01 sys
0.06 real 0.02 user 0.01 sys
0.07 real 0.02 user 0.01 sys
```
## Look-and-feel
### Fonts
Install [nerd fonts][nerd-fonts] via homebrew:
```zsh
brew tap homebrew/cask-fonts
brew install --cask font-meslo-lg-nerd-font
brew install --cask font-fira-code-nerd-font
brew install --cask font-hack-nerd-font
brew install --cask font-inconsolata-nerd-font
brew install --cask font-sauce-code-pro-nerd-font
```
### Color schemes
iTerm2 has some awesome [color schemes][iterm2-colors]. You can use them for more than
just iTerm2.
I use Space Gray:
## Resources
- [fish][fish]
- [antidote][antidote]
- [zephyr][zephyr]
- [zshzoo][zshzoo]
- [zsh_unplugged][zsh_unplugged]
- [prezto][prezto]
- [oh-my-zsh][oh-my-zsh]
- [supercharge your terminal with zsh][supercharge-zsh]
- [awesome zsh][awesome-zsh-plugins]
[antidote]: https://github.com/mattmc3/antidote
[awesome-zsh-plugins]: https://github.com/unixorn/awesome-zsh-plugins
[fish]: https://fishshell.com
[dotfiles]: https://dotfiles.github.io/
[homebrew]: https://brew.sh
[iterm2-colors]: https://github.com/mbadolato/iTerm2-Color-Schemes
[nerd-fonts]: https://github.com/ryanoasis/nerd-fonts
[oh-my-zsh]: https://github.com/ohmyzsh/ohmyzsh
[prezto]: https://github.com/sorin-ionescu/prezto
[starship-toml]: https://github.com/mattmc3/zdotdir/blob/main/prompt/starship.toml
[starship]: https://starship.rs
[supercharge-zsh]: https://blog.callstack.io/supercharge-your-terminal-with-zsh-8b369d689770
[zdotdir_gif]: https://raw.githubusercontent.com/mattmc3/zdotdir/resources/img/zdotdir.gif
[zephyr]: https://github.com/zshzoo/zephyr
[zsh_unplugged]: https://github.com/mattmc3/zsh_unplugged
[zshzoo]: https://github.com/zshzoo/zshzoo