Hello, I'm Lirian Su. I work primarily on macOS these days, and frequently on Unix systems too (cloud servers or WSL). Because I set up new environments so often, I keep this project to sync my various configurations across every machine I touch.

This repo happens to share my GitHub username, so GitHub also renders its README as my profile page. If you'd like to know more about me, feel free to read my introduction.

I'm lazy and primarily drive everything through shortcuts and hotkeys. This project defines numerous abbreviations, but the changes are purely additive — they don't alter any existing command habits.

For convenient installation, I've written the whole setup process as Python scripts. (So the first thing I do on a new computer is install a Python environment.)

First, ensure you have Python 3.12+ in your environment, then install with pip:

pip install lki && lki install

This command supports Unix, macOS, and Windows environments. If you encounter any issues, please report them as an Issue.

On a new Mac, after installing Homebrew, restore every tap, formula, and cask from the committed Brewfile with brew bundle --file ~/.lki/Brewfile. After installing new packages, refresh the list with brew bundle dump --file ~/.lki/Brewfile --force.

~/.gitconfig contains numerous git aliases:

# View git configuration
$ cat ~/.gitconfig

# Basic git abbreviations
$ git ci  # `git commit`
$ git br  # `git branch`
$ git pf  # `git push -f`
$ git sv  # `git save` <=> `git stash`
$ git ld  # `git load` <=> `git stash pop`

# Common git abbreviations
$ git cm    # amend last commit
$ git logg  # log in graph
$ git pd    # push dev with gitlab merge request created
$ git yes   # show what happened yesterday

~/.profile contains numerous bash aliases:

# View bash configuration
$ cat ~/.profile

# Common abbreviations
$ g st           # `git status`
$ reload         # re-source ~/.profile after an edit
$ pv sync --dev  # `pipenv sync --dev`

# Compound subcommand abbreviations
$ dpa  # `docker ps -a`
$ kgp  # `kubectl get pods`
$ gcm  # `git cm`

# fzf-powered helpers that I reach for constantly
$ ws <keyword>    # jump into a matching repo under ~/code/src
$ csh <host>      # ssh into a matching host from ~/.ssh/*config
$ kbash <pod>     # exec bash into a matching k8s pod

For Vim configuration, see another project liriansu-opus/dotvim

There's much more in this project, but the margin here is too small to contain it all. XD

Permissive MIT License, meaning you can make any changes — even change the author name to your own.

No worries — whether it's about the project or about me personally, or if you think a certain command isn't friendly enough, feel free to submit an Issue directly in the project.