# dotfiles

**Repository Path**: gkzhb/dotfiles

## Basic Information

- **Project Name**: dotfiles
- **Description**: My dotfiles
https://github.com/gkzhb/dotfiles
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-03-07
- **Last Updated**: 2026-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dotfiles

## Installation

You are suggested to folk this repo and clone the folked repo.

Use the following command to clone this repository(*replace the url with folked
repo's url*):

```bash
git clone --bare https://github.com/gkzhb/dotfiles.git $HOME/.dotfiles
```

Set an alias temporary, and use `cfg` as git command

```bash
alias cfg='git --git-dir=$HOME/.dotfiles --work-tree=$HOME'
```

Checkout the config files:

```bash
cfg checkout
```

And resolve conflicts.

Finally, run two bash scripts: `script/dotfiles/install.sh` and `script/dotfiles/init-after-clone.sh`.

## Requirements

* [fish-shell](https://github.com/fish-shell/fish-shell) as my default shell

Dependencies required by Neovim plugins:

* [Git](https://github.com/git/git) to install [lazy.nvim](https://github.com/folke/lazy.nvim)
* [nodejs/node: Node.js JavaScript runtime](https://github.com/nodejs/node) for coc.nvim
* [BurntSushi/ripgrep: ripgrep recursively searches directories for a regex pattern while respecting your gitignore](https://github.com/BurntSushi/ripgrep)
* [sharkdp/fd: A simple, fast and user-friendly alternative to 'find'](https://github.com/sharkdp/fd)

Suggested:

* [sst/opencode: AI coding agent, built for the terminal.](https://github.com/sst/opencode): awesome open source AI Coding Agent, alternative to Claude Code
  * With [NickvanDyke/opencode.nvim](https://github.com/NickvanDyke/opencode.nvim/tree/main), you will get awesome AI integration in the Neovim editor
* [junegunn/fzf: A command-line fuzzy finder](https://github.com/junegunn/fzf):
very useful cli tool to select item from a list
* [sxyazi/yazi](https://github.com/sxyazi/yazi): blazing fast async file manager in terminal and Neovim
* [ajeetdsouza/zoxide: A smarter cd command](https://github.com/ajeetdsouza/zoxide)

### Kitty

[Kitty](https://github.com/kovidgoyal/kitty) is a terminal. Use it on Mac OS and
Linux.  
[Config file](./.config/kitty/kitty.yml).

I use the onedark color theme as the color palette of my terminal.

### Alacritty

Alacritty is another terminal, simple and fast. I use it on Windows.  
[Config file](./.config/alacritty/alacritty.yml).

### tmux

See `.tmux.conf` and color theme file `.tmux/onedark.conf`. Use [tpm](https://github.com/tmux-plugins/tpm)
as plugin manager.

### Neovim

Details about my Neovim plugins: [gkzhb/dotfiles - Neovim configuration](https://dotfyle.com/gkzhb/dotfiles-config-nvim)

See [init.lua](./.config/nvim/init.lua). Use [lazy.nvim](https://github.com/folke/lazy.nvim)
as plugin manager.

Use VSCode color theme and
[coc.nvim](https://github.com/neoclide/coc.nvim) as the autocomplete tool which
is also LSP client. Also I add plenty of coc extensions in the config file.

### AeroSpace ~~yabai & skhd~~ (Mac OS only)

[AeroSpace](https://github.com/nikitabobko/AeroSpace)

[koekeishiya/yabai: A tiling window manager for macOS based on binary space partitioning](https://github.com/koekeishiya/yabai): [yabairc](./yabairc)

[koekeishiya/skhd: Simple hotkey daemon for macOS](https://github.com/koekeishiya/skhd): [skhdrc](./skhdrc)

I made a swiftbar plugin [gkzhb/yabai-spaces](https://github.com/gkzhb/yabai-spaces) to display yabai spaces and manage space labels which I put at `$HOME/scripts/yabai-spaces`.

## More about this dotfiles repository

* [How to store dotfiles | Atlassian Git Tutorial](https://www.atlassian.com/git/tutorials/dotfiles)
* [使用裸 Git 仓库备份 \*nix 系统用户配置文件 - ZHB's Blog](https://blog.gkzhb.top/post/2021-3-dotfiles/)