https://github.com/phansch/dotfiles

Useful dotfiles for i3, Ghostty, tmux, neovim, git, zsh and more | Tested daily on CI
https://github.com/phansch/dotfiles

ansible dotfiles ghostty gnu-stow i3 neovim stow tmux vim zsh

Last synced: 6 months ago
JSON representation

Useful dotfiles for i3, Ghostty, tmux, neovim, git, zsh and more | Tested daily on CI

• Host: GitHub
• URL: https://github.com/phansch/dotfiles
• Owner: phansch
• License: mit
• Created: 2013-10-05T16:19:53.000Z (about 12 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T18:56:11.000Z (6 months ago)
• Last Synced: 2025-04-01T19:45:47.720Z (6 months ago)
• Topics: ansible, dotfiles, ghostty, gnu-stow, i3, neovim, stow, tmux, vim, zsh
• Language: Shell
• Homepage:
• Size: 1.93 MB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/phansch/dotfiles/workflows/CI/badge.svg?branch=main)](https://github.com/phansch/dotfiles/actions)

## What's in there?

This is meant to be a 'minimal', **distraction free** setup. No fancy

statusbars, no crazy window decorations, no distractions.

With these dotfiles I want to automate as much as possible and keep UI clutter

to a minimum for a distraction-free environment.

The only exception for this is currently Neovim, where I'm using [LazyVim] to

set up everything. I had too many issues with my config breaking and I hope,

by 'outsourcing' it, it will break less often.

I **don't** recommend running the `setup` script on your machine unless

you understand what it does.  

I **do** recommend having a look through the various config files.

Below is a rough overview.

If you are interested in the CI setup, look [below](#ci-info).

### Window manager: i3

* i3bar is only shown when the modifier key is pressed

* i3bar only shows the workspaces, time and tray programs

### Terminal: Ghostty + tmux

Ghostty (vs. urxvt) improves various things for me:

* Much better HiDPI support

* Automatic config reloading (no more need for `xrdb -merge` and starting a new

  terminal

* Emoji support ✨

* Image support

The tmux status display has no additional information apart from windows.

![tmux status display](screenshots/screen-tmux.png)

### Shell: zsh

* Custom zsh prompt/theme

* CTRL+Z to send jobs to background and to foreground

* No oh-my-zsh, because it makes things slow

* Same completion as oh-my-zsh

![zsh prompt](screenshots/screen-zsh1.png)

### Editor: Vim

* Using [LazyVim] for the core IDE setup

* Support for 'line' cursor shape in insert mode if using nvim

* Turns syntax off for large files

* Open the current file in browser (Useful for markdown)

* Return to the same line when you reopen a file

* Switch between tmux and vim panes using the same shortcuts

### Git

* Pre-defined commit message with suggestions

### Ruby

* Basic rubocop.yml

* irbrc - start pry if possible

* gemrc - never download docs

### Scripts in bin/

* `off` Will ask you to do a daily review, time tracking and if you are fine with your journaling and then suspend the machine.

* `clean_rails` cleans cache and log files in rails projects

## Installation

### System bootstrapping

Just run the following command:

    wget --no-check-certificate https://github.com/phansch/dotfiles/raw/main/setup -O - | bash -s -- -s

This will:

1. Upgrade and autoclean system packages

2. Clone the dotfiles (or pull if they exist already)

3. Install the base packages

4. Symlink the dotfiles with `stow`

5. Print the command to run the optional playbooks

### Just the dotfiles

If you just want the dotfiles, clone them and use [stow](https://www.gnu.org/software/stow/) as below.

    git clone https://github.com/phansch/dotfiles.git $HOME/.dotfiles

    cd $HOME

    # Install stow

    sudo apt-get install stow

    # To install the ruby dotfiles. Replace `ruby` with the stow package you want.

    stow ruby --verbose=1 --target=$HOME/ --dir=$HOME/.dotfiles

### Environment variables

Some scripts, like the `off` script, use environment variables for configuration.

You can set these in your `~/.zshrc.local` which is sourced by `~/.zshrc` automatically.

The current environment variables are:

| Variable           | Function                                                      |

| ------------------ | ------------------------------------------------------------- |

| DAILY_REVIEW_LINK  | If set, opens the configured link when using the `off` script |

| WORK_TIME_TRACKING | If set, opens the configured link when using the `off` script |

## Development

Since it can be a bit problematic to test changes to the configuration on the actual machine where you want to make them, you can use Vagrant to test changes to the configuration.

You will need Vagrant and Virtualbox installed, then you can run:

    vagrant up

You can then either use `vagrant ssh` or connect to the VM through Virtualbox to have a GUI.

**Running the tests**

    run-parts test/

### CI Info

CI is trying to mirror a full Ubuntu installation in order to ensure the setup script doesn't fail.

* i3 config is invalid

* shellcheck found errors

* The full setup fails

[LazyVim]: http://www.lazyvim.org/