Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/achimnol/dotfiles

My little configurations
https://github.com/achimnol/dotfiles

Last synced: 4 days ago
JSON representation

My little configurations

Host: GitHub
URL: https://github.com/achimnol/dotfiles
Owner: achimnol
Created: 2015-05-18T08:15:32.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2024-09-21T17:29:00.000Z (about 2 months ago)
Last Synced: 2024-10-11T10:17:18.112Z (27 days ago)
Language: Vim Script
Size: 992 KB
Stars: 10
Watchers: 4
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# achimnol's dot files

## Overview

This is Joongi's semi-automated dotfiles distribution.

It has a deployment script (`deploy.py`) that generates configurations for different OS platforms (e.g., Windows, Linux, and Mac) using a "flavor" (e.g., home, work).
The script uses the template engine and [its simple syntax](http://bottlepy.org/docs/dev/stpl.html) from [bottle.py](http://bottlepy.org/docs/dev/index.html) (which is chosen because it is a single-file and self-contained), so you can use conditionals when writing templates (e.g., [vimrc](https://github.com/achimnol/dotfiles/blob/master/vimrc)).

## Configuration

Of course, this repository contains my *personal* settings.
After forking this repository, you need to customize `configuration.json`, in particular, **variables** section in flavor settings to change gitconfig user name and emails.

## Installation

### System Packages (Linux-Ubuntu)

```shell
sudo apt install build-essential pkg-config autoconf automake git-core tmux htop vim
sudo apt install gnupg-agent gnupg2
sudo apt install libssl-dev libreadline-dev libgdbm-dev zlib1g-dev libbz2-dev liblzma-dev libsqlite3-dev libffi-dev
sudo apt install hexyl bat # modern cli utils (Ubuntu 19.10+)
```

Some network debugging utilities:
```shell
sudo apt install dnsutils iproute2
```

### System Packages (macOS with Homebrew)

```shell
xcode-select --install
brew install git tmux htop python3
brew install macvim --with-override-system-vim --without-python --with-python3
brew install gpg-agent
brew install ncurses # for gen-italics-terminfo.sh
brew install openssl sqlite3 readline zlib xz gdbm tcl-tk
brew install exa fd hexyl bat # modern cli utils
```

Some network debugging utilities:
```shell
brew install iproute2mac
```

### Initializing oh-my-zsh (when using zsh, for Linux/Mac only)

```shell
wget https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh
```
or
```shell
curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh
```

### Initializing pyenv (Linux/Mac)

```shell
git clone https://github.com/pyenv/pyenv.git ~/.pyenv
git clone https://github.com/pyenv/pyenv-virtualenv.git ~/.pyenv/plugins/pyenv-virtualenv
git clone https://github.com/pyenv/pyenv-update.git ~/.pyenv/plugins/pyenv-update
```

#### pyenv 2.0+
**`.zprofile`** and **`.profile`** (depending on the content of `.profile`, you may symlink `.zprofile` to `.profile`)
```sh
export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init --path)"
```

**`.zshrc_local`**
```sh
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"
```

### Installing lsd (ls replacement)

[Visit the official repo](https://github.com/lsd-rs/lsd/releases) and download/install the lsd-musl deb package.

### Deploying the static configurations

```shell
./deploy.py --flavor home --skip-scripts
```

If any file already exists, it will ask you whether to overwrite it.
To overwrite always, add `--force`.

### NeoVim on Linux arm64/aarch64

Many NeoVim plugins require luajit instead of Lua 5.1 to work properly.
We can install NeoVim using Snap (`sudo snap install nvim --classic`) but this version is built with Lua 5.1
and plugins like Telescope breaks.

To build NeoVim by yourself, install a few prerequisite and make it from source.
[Check out the official build instructions.](https://github.com/neovim/neovim/blob/master/BUILD.md)

#### Setting NeoVim as the default editor/vi

To let NeoVim serve the default `vi` command on Ubuntu-like distributions,
first put the following script as `/usr/local/bin/nvim` *if installed via Snap*:
```bash
#! /bin/bash
/usr/bin/snap run nvim "$@"
```
If you have built and installed NeoVim by yourself, `/usr/local/bin/nvim` is already the actual executable.

Then, execute this following command:
```shell
sudo update-alternatives --install /usr/bin/editor editor /usr/local/bin/nvim 50
sudo update-alternatives --config editor
sudo update-alternatives --install /usr/bin/vi vi /usr/local/bin/nvim 50
sudo update-alternatives --config vi
```

### Initializing NeoVim

When NeoVim is executed for the first time, it will automatically install and load plugins via Lazy.

Install the CoC and treesitter plugins after initialization CoC itself.
```
:CocInstall coc-pyright coc-rust-analyzer coc-highlight
```

### Sample configuration for a local `coc-settings.json`

```json
{
"python.formatting.provider": "ruff",
"python.linting.mypyEnabled": true,
"python.linting.ruffEnabled": true,
"coc.preferences.formatOnSaveFiletypes": ["python"],
"python.pythonPath": "dist/export/python/virtualenvs/python-default/3.11.6/bin/python3"
}
```

### NodeJS for NeoVim CoC and npm packages

To install NodeJS as distro-specific packages, follow the instructions from [the nodesource distribution repository](https://github.com/nodesource/distributions).

To install multiple versions of NodeJS, use [the node version manager](http://github.com/nvm-sh/nvm).

### Enabling italics support in terminals (for Linux/Mac only)

To check if the italic font rednering works in your terminal, try:
```shell
echo -e "\e[3mfoo\e[23m"
```

If the above test command does NOT display an italic text, run:
```shell
./gen-italics-terminfo.sh
```

[A good guide is here.](https://www.reddit.com/r/vim/comments/24g8r8/italics_in_terminal_vim_and_tmux/)

### Setting up Git commit signing with the SSH keypair

```shell
git config --global user.signingkey ~/.ssh/id_rsa
```

### Installing the GitHub CLI (Ubuntu/Debian Linux)

```shell
./scripts/install-gh.sh
```

```shell
gh auth login
gh extension install seachicken/gh-poi # extension to clean up local branches
```

### Installing the latest mobile-shell (mosh) (Optional)

```shell
./scripts/install-mosh.sh
```

### Workarounding user font recognition and system clipboard access issues in tmux on macOS

```shell
brew install tmux reattach-to-user-namespace
```

Set your iTerm profile's startup command to use `reattach-to-user-namespace -l zsh`.
(Replace zsh with your favorite shell.)

### Enabling macOS key repeats

Run the following in the terminal and restart any apps to apply:
```shell
defaults write -g ApplePressAndHoldEnabled -bool false
```

### Making macOS key repeat faster

Run the followings in the terminal and logout/login again.
```shell
defaults write -g InitialKeyRepeat -int 10 # normal minimum is 15 (225 ms)
defaults write -g KeyRepeat -int 1 # normal minimum is 2 (30 ms)
```

### Making oh-my-zsh's `git_current_branch` even faster (optional)

```shell
git clone https://github.com/notfed/git-branch-name
make
sudo install git-branch-name /usr/local/bin
```

Then replace the `git_current_branch` function in `~/.oh-my-zsh/lib/git.zsh` to:
```shell
function git_current_branch() {
git-branch-name -q
}
```

## Archived instructions (not used currently)

### Initializing Vim Vundle

This repository does not include [Vundle](https://github.com/gmarik/Vundle.vim) and other vim plugins.
For the first time after running `deploy.py`, you must run the followings to get vim to work properly.

On Linux and Mac,
```console
$ git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim
$ vim +PluginInstall +qall
```

On Windows,
```console
> git clone https://github.com/gmarik/Vundle.vim.git %USERPROFILE%/vimfiles/bundle/Vundle.vim
```
Run gVim and execute `:PluginInstall`.

If your user name contains non-ASCII characters, make a ASCII symbolic link of your `%USERPROFILE%` directoy as follows:
```console
> mklink /d ASCIINAME NONASCIINAME
> set USERPROFILE=C:\Users\ASCIINAME
> set HOMEPATH=\Users\ASCIINAME
> "C:\Program Files (x86)\Vim\vim74\gvim.exe"
```
and then run `:PluginInstall`.

### Initializing GnuPG (Linux)

**`.profile`** or **`.zshrc_local`**:
```sh
# gpg-agent setup
export GPG_TTY=`tty`
export SSH_AUTH_SOCK="$HOME/.gnupg/S.gpg-agent.ssh"
gpgconf --launch gpg-agent
```

Note: Bash on Ubuntu reads `.profile` by default but ZSH does not.
In this case, add the following to `.zshrc_local`:

```sh
if [[ -o login ]]; then
source $HOME/.profile
fi
```

Then, import the PGP key as you need.