Dotties

Dotties

Overview

Dotties is a simple dotfile management script. It saves specified dotfiles in the home directory to a secret Gist and clone them from the Gist.

Requirement

• GitHub CLI gh

Homebrew/LinuxBrew

brew install gh

Warning to Ubuntu/Debian users about snap

For Ubuntu/Debian, use apt. snap won't work with hidden files. Download a Debian package (.deb) file and double click the downloaded file or run:

sudo apt install ./gh_1.13.1_linux_amd64.deb

• Python to open a browser

Installation

Awesome package manager

awesome install shinokada/dotties

Homebrew/Linuxbrew

brew tap shinokada/dotties
brew install dotties

Linux/Debian/Ubuntu

Download the latest deb file from the release page.

sudo apt install dotties_XXXXXXX.deb

Usage

Create a new .dotties file with all dotfiles in your Home directory

dotties

This will pick up all dotfiles from your Home dir and write them in the .dotties file.

Is empty

Run dotties -i or dotties --isempty to print files with empty content.

Edit the .dotties file to edit:

dotties -e
# or
dotties --edit

Your terminal editor will open the dotties file.

Read the dotties file:

dotties -r
# or
dotties --read

This will print your .dotties content on your terminal.

Save contents from files in the .dotties to a secret Gist

dotties -G
# or
dotties --Gist

This will upload all your dotfiles in the .dotties to a Gist. The Gist URL will be stored in the ~/.dotties/gisturl file.

Edit the Dotties Gist

dotties -E
# or
dotties --Edit

The GitHub CLI will open your Gist to edit/submit/cancel.

View the Dotties Gist

dotties -V
# or
dotties --View

The GitHub CLI will view the Gist.

Clone the Dotties Gist

dotties -C target-dir
# or
dotties --clone

This will clone the dotfile Gist. If the target dir isn't given it will clone to the current directory.

Delete the Dotties Gist

dotties -D
# or
dotties --Delete

Other options

List all dotfiles from your home dir:

dotties -l
# or
dotties --local

Print help.

dotties -h
# or
dotties --help

Print the version.

dotties -v
# or
dotties --version

Author

Shinichi Okada

License

Please see license.txt.