/macdot

macOS configuration by Griffin Ryan

Primary LanguageShellMIT LicenseMIT

Macdot - a macOS dotfile manager

main.gif

Overview

Macdot is a CLI designed to make configuring UNIX computers easy.

Macdot is a dotfile manager. macdot easily configures dotfiles on macOS and Linux systems from the command line.


Installation

To download Macdot with homebrew, run the following from the command line:

brew tap griffinryan/macdot
brew install macdot

Usage

There are a few different features to Macdot. An easy way to start learning the Macdot magic is to simply run macdot in any shell.

macdot

main.gif


macdot save

The save function saves a backup of your dotfiles in your home directory at /.Macdot/ to restore later.

macdot save

save.gif


macdot restore

The restore function reverts the dotfiles in your home directory to the dotfiles stored at /.Macdot/ from using macdot save.

macdot restore

restore.gif


macdot backup

The backup function creates a backup of your dotfiles in a new directory. Using macdot backup will ask the user for a title of the new folder in the current working directory.

macdot backup

backup.gif


macdot dot

The dot function configures dotfiles for macOS. This includes configurations for the fish shell, the iTerm2 terminal, git, vim, and much more!

macdot dot

dot.gif

macdot save is always used with macdot dot. Before using dot, dotfiles are automatically backed up in the home directory at /.Macdot/.


macdot help

The help function displays much more!

macdot help

Thanks for using Macdot!

main.gif


Notes

Macdot can make a lot of changes to your macOS system that can be a slightly challenging to revert! Always use macdot backup or macdot save before making changes to your system.

Thank you for using Macdot!

Go see my portfolio!

https://griffinryan.com/

Software by Griffin Ryan, 2022.