Skip to content

Repository files navigation

Dot

A simple dotfiles manager

Features

  • install
    • clones and checks out a dotfiles repo
    • automatically backs up conflicting files
    • automatically sets useful git config
    • run a custom post-install script to perform any additional setup
    • uses progress bars to neatly display each step of the installation
  • init
    • create a dotfiles repo
  • list
    • list all tracked files in the repo line-by-line
    • can be easily piped into fzf
  • git
    • run any git command without having to specify --git-dir and --work-tree
    • commands can be run from any directory

Usage

Install a dotfiles repo in the current HOME dir, in a subfolder called .dotfiles.

dot install <url>

Precede normal git commands with dot to run them in the dotfiles repo.

dot git fetch -p

If the name of the git command doesn't match a dot command, then you can omit "git".

dot add .vimrc
dot status
dot pull

dot init # will run the dot command, not the git command

Create a dotfiles repo called .dotfiles in the current HOME dir.

dot init

Specify a different home dir or dotfiles repo dir in any command.

dot --home /home/user/test --repo /home/user/test/.dot init

Use a different home dir or repo dir all the time by putting them in a config file in the platform standard location (e.g. $HOME/.config/dot/config.toml on linux). Currently, they don't support environment variables. These paths should be absolute, otherwise they'll be resolved relative to the working directory where the command was run.

home_path = "/home/user/test"
repo_path = "/home/user/test/.dot"

About

A utility for working with dotfiles

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages