https://github.com/nkahe/zsh
This is my maximalistic Z shell aka Zsh configuration. It uses flexible and fast Zinit plugin manager and part of Prezto Configuration Framework.
https://github.com/nkahe/zsh
zinit zsh zsh-config zsh-configuration
Last synced: 3 months ago
JSON representation
This is my maximalistic Z shell aka Zsh configuration. It uses flexible and fast Zinit plugin manager and part of Prezto Configuration Framework.
- Host: GitHub
- URL: https://github.com/nkahe/zsh
- Owner: nkahe
- License: mit
- Created: 2025-01-27T09:27:51.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-18T15:36:32.000Z (3 months ago)
- Last Synced: 2025-03-18T16:41:24.861Z (3 months ago)
- Topics: zinit, zsh, zsh-config, zsh-configuration
- Language: Shell
- Homepage:
- Size: 212 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My Zsh configuration
This is my maximalistic [Z shell aka Zsh](httpszsh.sourceforge.io/) configuration. It uses flexible and fast [Zinit plugin manager](https://github.com/zdharma-continuum/zinit). Some modules from [Prezto configuration framework](https://github.com/sorin-ionescu/prezto) are used and [some are forked from them](#forked-prezto-modules). My environment is Linux but this should work in Mac too although isn't actively tested.
## Features
- Full featured, yet fast.
- Good settings mainly from Prezto.
- Many plugins and snippets and their settings loaded with deferred loading for faster startup.
- Many aliases, user functions and keybindings.
### Plugins
- [fast-syntax-highlighting: Feature-rich syntax highlighting](https://github.com/zdharma-continuum/fast-syntax-highlighting)
- [zsh-autosuggestions: Fish-like autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)
- [zsh-history-substring-search: 🐠 ZSH port of Fish history search ](https://github.com/zsh-users/zsh-history-substring-search) with key bindings for emacs, vi -insert and normal modes.
- [zsh-completions: Additional completion definitions for Zsh.](https://github.com/clarketm/zsh-completions)
- [zsh-vi-mode: 💻 A better and friendly vi(vim) mode plugin for ZSH.](https://github.com/jeffreytse/zsh-vi-mode)
- [moar: Pager designed to just do the right thing without any configuration.](https://github.com/walles/moar)
- [command_help: Extract help text from builtin commands and man pages](https://github.com/learnbyexample/command_help)
- [bashmount: Tool to mount and unmount removable media from the command-line](https://github.com/jamielinux/bashmount)
- more
## Requirements
- zsh, git
Recommended:
- [Nerd Fonts](https://www.nerdfonts.com/) - fonts with glyphs for Starship prompt and eza, etc.
- [Advanced and fast Starship -prompt](https://starship.rs)
- [eza: A modern alternative to ls](https://github.com/eza-community/eza) which is also recommended, fzf fuzzy finder, for Wayland desktop: wl-copy for clipboard operations.
Optional:
- [zoxide: A smarter cd command. Supports all major shells.](https://github.com/ajeetdsouza/zoxide)
- curl - for scripts getting information from web.
- [grc - generic colouriser](https://github.com/garabik/grc)
- [ccze - a fast log colorizer](https://github.com/cornet/ccze)
[cheat - allows you to create and view interactive cheatsheets on the command-line](https://github.com/cheat/cheat)
- [navi: An interactive cheatsheet tool for the command-line](https://github.com/denisidoro/navi)
- [tldr-pages/tldr-python-client: Python command-line client for tldr pages 📚](https://github.com/tldr-pages/tldr-python-client)
- [translate-shell: Command-line translator using Google Translate, Bing Translator, Yandex.Translate, etc.](https://github.com/soimort/translate-shell)
- [termdown: Countdown timer and stopwatch in your terminal](https://github.com/trehn/termdown)
## Installation
1. Install requirements.
2. Git clone this repo in ~/.config which makes sub-directory "zsh". Custom directory can also be used.
3. If ~/.zshenv already exists backup by renaming it. Make a hidden symlink to home directory pointing zshenv -file:
```
ln -s ~/.config/zsh/zshenv $HOME/.zshenv
```
or copy it:
```
cp ~/.config/zsh/zshenv $HOME/.zshenv
```
4. If using different directory for the config, change it in .zshenv accordingly.
5. Start a new shell. If Zinit installation is not found, it is installed automatically
and all defined external plugins and snippets are being pulled.
## Configuration files
- .zshenv - Tells Zsh where rest of the files are. In home directory should be a symlink with same the name to this file or a copy of it.
- .zprofile - Zsh -specific environment variables and settings.
- .zshrc - First file that is processed during init and main configuration file of which rest of configurations are sourced.
- settings.zsh - General settings.
- completion.zsh - Completion settings. *
- aliases.sh - Misc aliases and functions that can be sourced from Bash too.
- zsh-aliases.zsh - Zsh -specific aliases and functions.
- bindings.zsh - Keybindings. *
All .zsh-files directly under these directories are sourced from .zshrc during init.
- plugins/ - Plugin specs mainly for Zinit. Files can contain many specs.
- snippets/ - Different snippets. Some are Zinit specs for external snippet.
- titles.zsh *
- prezto.zsh - Specs for used Prezto modules.
- *.sh - Snippets that can be sourced from Bash too.
- completions/ - Additional locally added completions.
> [!NOTE]
> `*` These are derived from Prezto modules. Changes can be seen in next section.
### Forked Prezto modules
For license see [LICENSE -file](./LICENSE). Settings are changed directly in the file instead of .zpreztorc like in Prezto.
#### bindings.zsh
- Forked from Prezto editor -module.
Changes, added:
- Command to list bindings.
- Bindings:
- Toggle Vi / Emacs command mode.
- cd to previous / next directory, ls
- Support for some more common keys and shortcuts.
Removed:
- Functions for prompts since prompt is defined as plugin instead in plugins/prompt.zsh
- No definitions for plugins since deferred loading is used.
- Some bindings I don't use.
#### titles.zsh
- Forked from terminal module in Prezto.
Changes:
- Added support for Yakuake and Konsole -terminals which set titles differently using qdbus.
- Spams messages to journalctl but works.
- Fix: drop first word of title if it's sudo, su, ssh, mosh or rake.
- Allow longer titles for Terminator -terminal which has wide tabs.
#### completion.zsh
- Forked from completion module in Prezto.
Changes:
- No LS_COLORS definition since I use fork of [LS_COLORS: A collection of LS_COLORS definitions; needs your contribution!](https://github.com/trapd00r/LS_COLORS) instead.
- No compinit loading since it's done using Zinit when initializing syntax highlighting -plugin.
- Mutt's path ~/.mutt -> ~/.config/mutt
- Use $ZSH_CACHE_DIR for caching.
- Completion settings for more text editors, killall, Taskwarrior, Docker, Angular cli.
- When new programs is installed, auto update autocomplete without reloading shell.
## License
See [LICENSE -file](./LICENSE)