https://github.com/smkent/dotfiles
🐧 🐚 smkent's dotfiles
https://github.com/smkent/dotfiles
bash bashrc dotfiles git github-actions gnupg linux mutt powerline-fonts pre-commit python screenshot tmux vim vimrc
Last synced: about 1 month ago
JSON representation
🐧 🐚 smkent's dotfiles
- Host: GitHub
- URL: https://github.com/smkent/dotfiles
- Owner: smkent
- Created: 2016-05-19T02:49:54.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T03:17:33.000Z (about 2 months ago)
- Last Synced: 2025-04-03T04:23:32.529Z (about 2 months ago)
- Topics: bash, bashrc, dotfiles, git, github-actions, gnupg, linux, mutt, powerline-fonts, pre-commit, python, screenshot, tmux, vim, vimrc
- Language: Vim Script
- Homepage:
- Size: 2.25 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# smkent's dotfiles
My Linux environment configuration
Quick jump: [shell](#shell), [git](#git), [mutt](#mutt), [tmux](#tmux),
[vim](#vim)
## Design
This repository contains flat files meant to be used in place within `${HOME}`.
My dotfiles are designed be portable with minimal required dependencies (git,
bash/zsh, Python, and the
[Powerline fonts](https://github.com/powerline/fonts)).
## Installation
I recommend looking at the code and trying out individual parts you are
interested in before installing the entire set of dotfiles.
To install these dotfiles in your home directory, first clone the repository:
```shell
$ cd ~
$ git clone https://github.com/smkent/dotfiles
$ mv dotfiles/.git .
$ rm -rf dotfiles/
```
Next, review changes to any existing dotfiles using `git status` and `git diff`.
When satisfied, complete installation with:
```shell
$ git checkout .
```
### Configuration
To configure your git email address and username to be hidden from shell
prompts, run [`dotfiles-config`](/.dotfiles/bin/dotfiles-config).
To use a different profile picture, remove or replace `.face`.
### Dependency installation
My [vim-airline](https://github.com/vim-airline/vim-airline) and
[tmux](https://github.com/tmux/tmux) configurations require the [Powerline
fonts](https://github.com/powerline/fonts), which can be installed using
[`install-fonts`](/.dotfiles/bin/install-fonts) after installing this
repository.
More features become available when optional dependencies are installed:
* [shellcheck](https://github.com/koalaman/shellcheck) and
[flake8](https://pypi.python.org/pypi/flake8) (for
[ALE](https://github.com/w0rp/ale))
* `ctags` (for
[vim-gutentags](https://github.com/ludovicchabant/vim-gutentags),
typically available as the `exuberant-ctags` package)
* `xclip` (for copying to the system clipboard in tmux)
* [terminal_markdown_viewer](https://github.com/axiros/terminal_markdown_viewer)
(for previewing Markdown files with
[vim-pipe-preview](https://github.com/smkent/vim-pipe-preview))
Run [`dotfiles-deps`](/.dotfiles/bin/dotfiles-deps) to see the executable path
and version information for programs that this repository configures or depends
on.
## Features
### Shell
My shell configuration primarily supports Bash, but has also been set up to work
with zsh on OS X.
Prompt features:
* Display username if different from the value of `prompt_hide_user` configured
via [`dotfiles-config`](/.dotfiles/bin/dotfiles-config).
* Display current directory name if different from `${HOME}`
* Display exit code of the previous command if nonzero (or `bg` / `^C` when
backgrounding a job or typing Ctrl-C, respectively)
* Display runtime of the previous command if longer than 10 seconds
* Display size of the directory stack if not empty
* Display number of background jobs if any
* Display git branch (or hash on detached HEAD) if the current directory is a
git repository
Automatic update and reload:
* Changes to shell [`rc`](/.dotfiles/shell/rc) and any dependent files (such as
shell [`aliases`](/.dotfiles/shell/aliases)) cause the environment to be
automatically reloaded.
* Home directory repository updates are checked and fetched automatically via
[`dotfiles-auto-update`](/.dotfiles/bin/dotfiles-auto-update).
### Tmux
For a more detailed tmux configuration summary, see
[`.dotfiles/doc/tmux.md`](/.dotfiles/doc/tmux.md)
* Use Ctrl+a as the prefix key (similar to GNU screen)
* Use vi-style mode keys
* Additional vim-style key bindings:
* Ctrl+h/j/k/l for traversing panes (using
[vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator))
* Create window splits with Ctrl+a s (horizontal) or Ctrl+a v (vertical)
* Move between windows with F7/F8
* Alt+<arrow keys> for resizing panes
* Custom status bar configuration
* Window ID highlight inspired by [the screenshot in this
thread](http://crunchbang.org/forums/viewtopic.php?id=20504)
* Automatic environment variable updates in shell (ex. `SSH_AUTH_SOCK`) after
reattaching to a session (changes to the tmux session socket's ctime cause
the shell to reload tmux session environment variable values)
* Shell helper aliases:
* `tn`: New session. Takes an optional session name argument.
* `ta`: Attach to session. Takes an optional session name argument.
* `tl`: List sessions.
### Vim
For more detailed vim configuration summary, see
[`.dotfiles/doc/vim.md`](/.dotfiles/doc/vim.md)
Basic settings:
* The usual basic settings (line numbers, syntax highlighting, etc.)
* Quit vim using `q` in normal mode
* Save files by pressing F2 or Ctrl+S, or save and quit with `Q` in normal mode
* Highlight 81st column (via Vim 7.3+'s `colorcolumn` feature)
* Plugins managed by [vim-plug](https://github.com/junegunn/vim-plug)
Development plugins:
* Real-time linting with [ALE](https://github.com/w0rp/ale)
* Code navigation and completion using
[jedi-vim](https://github.com/davidhalter/jedi-vim) and
[completor](https://github.com/maralla/completor.vim)
* File, tags, etc. searching via [fzf](https://github.com/junegunn/fzf.vim)
Misc:
* Custom [vim-airline](https://github.com/vim-airline/vim-airline) color scheme
* Some basic and [vim-surround](https://github.com/tpope/vim-surround) keymaps
from [YADR (Yet Another Dotfile Repo)](https://github.com/skwp/dotfiles/)
### Git
#### Basic settings
* Use `less` with 4-column tab stops
* Set push default to `upstream`
* Enable `diff3` conflict resolution style
* Disable `git status` hints
* Enable rename and copy detection by default
* Enable mnemonic prefixes in `git diff`
#### Custom colors
* `git branch`: Current branch in brighter green, remote branches in brighter
red, upstream branches in blue bold
* `--decorate` (with `git log`, etc.): HEAD in red bold, remote branches in
blue bold, tags in yellow bold
* `git diff`: Brighter green and red for added and removed, hunk header (line
numbers changed) in brighter blue bold, hunk function header in magenta bold
* `git grep`: Matches in orange, matching filenames in purple, line numbers in
brighter green, function names in yellow, and separators in gray
* `git status`: Branch name in bold and underlined, added files in brighter
green, changed files in brighter red, files with conflicts in yellow, and
untracked files in blue
#### Aliases
See my [.gitconfig](/.gitconfig) for the full list of aliases. Some of the more
useful aliases are:
* `ca`: "commit amend" (`git commit --amend`)
* `cb`: "create branch" (Creates a new branch at either the specified point or
current HEAD, copying remote tracking branch information if available)
* `cf`: "commit fixup" (`git commit --amend --no-edit`)
* `ds`: "diff staged" (`git diff --staged`)
* `dw`: "word diff" (`git diff --word-diff=color`)
* `fa`: "find alias," based on [the "finda" alias from
here](http://brettterpstra.com/2014/08/04/shell-tricks-one-git-alias-to-rule-them-all/)
(Type "git fa" followed by an optional grep term to see all configured
aliases, or aliases matching the specified search term)
* log aliases:
* `l`: "log" (Similar to basic `git log`, but with extra colors, commit date
and relative date instead of author date)
* `lc`: "log compact" (Log format with commit and metadata on one line
followed by full commit messages)
* `lf`: "log files" (One line per commit followed by the changed file list
produced by `--numstat`)
* `lo`: "log oneline" (One line per commit, with the relative commit date on
the left)
* `lx`: "log eXtra" (Similar to the `l` alias, but with both author and
committer information)
* `ri`: "rebase interactive" (Specify a base commit, number of commits such as
`git ri 3`, or no argument to rebase all commits on on the current branch's
remote tracking branch)
* `ub`: "upstream branch" (Shows the output of `git show-branch` for the
current branch and its upstream tracking branch)
### Mutt
* Configure the sidebar but hide it by default (requires Mutt 1.7.0+ or the
sidebar patch)
* Sort and display messages by thread
* Message index color highlights, including highlighting messages sent only to
me and PGP-encrypted messages
* Compose mail using vim
* Vim-style navigation keybindings (`gg`, `G`, `Ctrl+b`, `Ctrl+f`)
* [`format=flowed`](http://joeclark.org/ffaq.html) support when composing and
reading mail
* PGP support with outgoing message signing enabled by default
* Custom status bar formats
## Development
Static checks are managed by [pre-commit][pre-commit].
Installation via [`pipx`][pipx]:
```console
pip install pipx
pipx install pre-commit
pre-commit install
```
Installation via `pip`:
```console
pip install pre-commit
pre-commit install
```
## Licensing and attribution
Parts of this repository contain third-party code, which is copyright their
respective owners and bound by the license terms specified by each original
source. Every effort has been made to identify third-party code within this
repository; sources are cited within the code base and/or in the commit(s) in
which pieces of third-party code were added to the repository.
Original code in this repository is published under the MIT license. See
[`.dotfiles/doc/LICENSE`](/.dotfiles/doc/LICENSE) for licensing information.
[pipx]: https://pypa.github.io/pipx/
[pre-commit]: https://pre-commit.com/