Personal zsh configuration

Go to file

Alexander Rosenberg 40900a9973 Update submodules		2024-03-08 19:30:47 -08:00
plugins	Update submodules	2024-03-08 19:30:47 -08:00
.gitignore	Initial commit	2022-08-28 02:52:37 -07:00
.gitmodules	Various changes	2022-11-30 23:28:40 -08:00
arch.zsh	Fix arch.zsh	2023-10-15 22:39:36 -07:00
bookmark.zsh	Update docs and add an option for graphical login	2024-01-12 15:05:09 -08:00
early-init.zsh	Update early-init.zsh	2024-02-29 19:39:12 -08:00
init.zsh	Clean up init.zsh	2024-03-04 22:44:22 -08:00
LICENSE	Initial commit	2022-08-28 02:52:37 -07:00
README.md	Add fzf to README.md	2024-01-12 15:09:49 -08:00

README.md

zsh-config

This is my personal zsh configuraton.

Requirements

starship - a pretty and fast prompt
direnv* - runs on cd, safely set enviroment
eza* - better ls
bat* - better cat, less, man, etc.
trash-cli* - safer deletion
fzf* - better auto-complete

(* = optional)

Installation

Clone this repo and init the submodules

git clone 'https://git.zander.im/Zander671/zsh-config.git'
git submodule init && git submodule update

Create a .zshrc and fill it with something like this:

ZSH_CONFIG_DIR="path/to/this/repo" # This variable *MUST* be set
source "${ZSH_CONFIG_DIR}/init.zsh"

Optionally, set some other variables (before the source line):

ZSH_BOOKMARK_DIR: Bookmark directory (default: ~/.cache/zsh/bookmarks)
ZSH_BOOKMARK_LS: If true, run ls after jumping to a bookmark (default: true)
ZSH_GRAPHICAL_LOGIN: Whether or not to enable starting a graphical session when a login shell is started (default: true)

Aliases

I use a lot of aliases. Because a lot of the aliases are only enabled if the corresponding piece of software is installed (see above), it is hard to give a full list. Therefore you should think of the following list as a guide and read init.zsh if you want a full list.

ls: eza --git -F
la: eza --git -Fa
l: eza --git -Fl
ll: eza --git -Fla
cat: bat --paging=never
pcat: bat -pp
ncat: bat -pp --color=never
e: emacsclient -a nvim -nw
n: emacsclient -a nvim -nw
emacs: emacsclient -a nvim -nw
d: start dired in either the current or provided directory
dired: start dired in either the current or provided directory
se: sudoedit
mv: mv -i
cp: cp -i
rm: disabled if trash-cli is installed
tp: trash-put
trr: trash-restore
trl: trash-list
tre: trash-empty
trm: trash-rm
gt: git status
ga: git add
gaa: git add -A
gc: git commit
gf: git fetch
gu: git pull
gp: git push
gcm: git commit -m, but treat all following args as the message (like echo)
gacm: git commit -am, but treat all following args as the message (like echo)

Configuration

Previous versions of this configuration supported files that were not under version control to be run during initialization of the shell. However the current version does not support this. Configuring the shell requires editing either init.zsh or early-init.zsh.