Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiyoon/dotfiles
NeoVim Tmux IDE configuration
https://github.com/kiyoon/dotfiles
Last synced: 17 days ago
JSON representation
NeoVim Tmux IDE configuration
- Host: GitHub
- URL: https://github.com/kiyoon/dotfiles
- Owner: kiyoon
- Created: 2023-01-27T01:21:49.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T08:04:28.000Z (6 months ago)
- Last Synced: 2024-05-28T19:19:51.382Z (6 months ago)
- Language: Lua
- Size: 768 KB
- Stars: 24
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# dotfiles that work without sudo
This is a modern Neovim, Tmux, Zsh configuration that supports installing everything locally (i.e. non-system-wide user install, not using sudo).
You can enjoy working on a remote SSH server without root permission, just like you do locally.
## Keep it stable!
This repository includes a GitHub Actions that automatically checks if the commit hasn't been made for 1 week.
If it has not been updated for 1 week, we consider that commit to be 'stable' and automatically bump version with `stable` tag.
In order to try the stable version, just run `dotstable` after setting up the zsh. This will also pull neovim plugin versions that have been used for the stable commit.
Also, it has many versions of vim configurations.
- `vi` to run a fully-featured bleeding-edge configuration of neovim.
- `vic` to run neovim with stable and mild configuration using CoC. It's a balance between the two, and should be used when the first option is broken.
- `lazyvim` to run pre-configured [LazyVim](https://github.com/LazyVim/LazyVim).
- `\vim` to run original vim with no plugins (only simple `.vimrc`)
- `csvi` to read CSV files. `:CsvAlign` or `:TsvAlign` to align columns and `H`, `L` to move by columns.
- Use `vscode_init.lua` for VSCode-Neovim.
## Features
### Zsh
- Feature-rich prompt powered by [Starship](https://starship.rs)
- Autocomplete, autosuggest
- Syntax highlighting
- Vim mode
- Fuzzy searching with [fzf](https://github.com/junegunn/fzf)
- Try `Ctrl+t` to find file, `Alt+c` to change directory, `Ctrl+r` to reverse search commands.
- Smart change directory with [Zoxide](https://github.com/ajeetdsouza/zoxide)
- Try `z ` like `z dot` will go to the `~/.config/dotfiles`.
### Neovim
- Yank registers synchronised with tmux. Yank from neovim and paste on tmux. Copy from tmux and paste on neovim.
- See more in [nvim/README.md](nvim/README.md)
### Tmux
- Mouse-enabled interactive tree view with [Treemux](https://github.com/kiyoon/treemux)
- Status bar that shows battery, CPU, GPU, RAM, weather, and git with [tmux-dracula fork](https://github.com/kiyoon/tmux-dracula)
- See more in [tmux/README.md](tmux/README.md)
## Requirements
- Linux x86-64, macOS, Windows WSL2
- Neovim v0.10.0 (make sure you use this exact version)
- Tmux v3.4
- Zsh v5.9 (in v5.8 highlighting will look weird and fzf-tab will remove some lines)
On Ubuntu, maybe you need to install some dependencies:
```bash
sudo apt update
sudo apt install -y python3.11-venv # for neovim's mason.nvim
# NOTE: change the version number depending on your system's python version.
```
## Steps
1. Install dotfiles
```bash
cd ~/.config # it doesn't have to be here. Just install anywhere
git clone https://github.com/kiyoon/dotfiles
# WARNING: ./symlink.sh will override existing dotfiles without validation (but will create a backup).
# The old dotfiles will be moved with '~' suffix.
# Use with care if you configured something manually.
cd dotfiles
./symlink.sh
```
2. Install zsh, oh-my-zsh
```bash
oh-my-zsh/zsh-local-install.sh
oh-my-zsh/install-installers.sh
source ~/.cargo/env # activate `cargo install ...`
oh-my-zsh/apps-local-install.sh
oh-my-zsh/launch-zsh-in-bash.sh
git submodule update --init --remote # Install and update all zsh plugins
```
NOTE: some steps like `apps-local-install.sh` may not work from the first run, because they break with missing dependencies easily.
Kindly try it again after re-opening your terminal, if some error occurs.
Open your terminal again and you'll see you're running zsh.
See [oh-my-zsh/README.md](oh-my-zsh/README.md) for details.
3. Install neovim and tmux
You need Neovim v0.10.0. The fold column will look ugly in v0.8.x.
On Linux, you can install locally using:
```bash
./install-nvim-tmux-locally-linux.sh
```
This will download the latest appimage for each and extract at `~/.local/bin`.
Install neovim dependencies:
```bash
nvim/install-dependencies.sh
```
Install tmux plugins:
```bash
tmux/install-plugins.sh
```
4. Install others
```bash
# You might want to symlink dotfiles again in case some scripts overrode them
./symlink.sh
# You only need to install it to the local computer, not in SSH host computer.
./install-nerdfont.sh
# If you're using wezterm (recommended), install terminfo
wezterm/terminfo.sh
```
5. Install / Update dotfiles, apps, plugins etc.
```zsh
# WARNING: This includes calling ./symlink.sh so the dotfile symlinks will be updated.
dotupdate # Use if you want to update to the latest commit
dotstable # Use if you want to use the stable tag
dotupdate # Specify the tag/commit you want to use
```
## SSH with WezTerm
If you ssh into a remote server, it won't understand the terminal and the UI will break (like backspace seems to work like space).
You need to install `wezterm.terminfo` on the server.
```bash
bash wezterm/terminfo.sh # run this before ssh into a new server. Only need it once.
ssh
```
## Docker
You can use the provided Dockerfile that has everything installed.
```bash
docker pull ghcr.io/kiyoon/dotfiles
docker run -it --rm \
-u $UID:$UID \
-e TERM=$TERM \
-e TERM_PROGRAM=$TERM_PROGRAM \
-e TERM_PROGRAM_VERSION=$TERM_PROGRAM_VERSION \
ghcr.io/kiyoon/dotfiles
```
## Implementation details
### Keychron knob
To support Keychron knob, I mapped the knob using VIA as following:
- Counter Clockwise: `F3` (`F2` on Mac)
- Clockwise: `F6`
- Press: `F7`
- Fn + Counter Clockwise: `F8`
- Fn + Clockwise: `F10`
- Fn + Press: `F9`
You'll see the keymaps in tmux, wezterm, zsh and neovim.
For example,
```sh
# 01_env.sh
bindkey "^[OR" dirhistory_zle_dirhistory_back # F3, knob counter-clockwise
bindkey "^[[15~" dirhistory_zle_dirhistory_back # F2, knob counter-clockwise (mac)
bindkey "^[[17~" dirhistory_zle_dirhistory_future # F6, knob clockwise
bindkey "^[[18~" dirhistory_zle_dirhistory_up # F7, knob click
```
In NeoVim, `` means `Shift + F1`, `` means `Ctrl + F1`.
Sometimes it is hard to pass the exact key sequence to the terminal. For example, skhd intercepts `F6` and it can't
pass the same key to the terminal. Thus, I used `F5` in some cases.