/dotfiles

Dotfiles for macOS and Linux

Primary LanguageShell

dotfiles

These are my dotfiles. Take anything you want, but at your own risk.

It targets macOS systems, but it should work on *nix as well (with apt-get).

Package overview

Install

On a sparkling fresh installation of macOS:

sudo softwareupdate -i -a
xcode-select --install

The Xcode Command Line Tools includes git and make (not available on stock macOS). Then, install this repo with curl available:

bash -c "`curl -fsSL https://raw.githubusercontent.com/lumaxis/dotfiles/main/remote-install.sh`"

This will clone (using git), or download (using curl or wget), this repo to ~/dotfiles. Alternatively, clone manually into the desired location:

git clone https://github.com/lumaxis/dotfiles.git ~/dotfiles

Use the Makefile to install everything listed above, and symlink runcom and config (using stow):

cd ~/dotfiles
make

Post-install

  • dotfiles dock (set Dock items)
  • dotfiles macos (set macOS defaults)
  • Mackup
    • Log in to iCloud (and wait until synced!)
    • mackup restore

The dotfiles command

$ dotfiles help
Usage: dotfiles <command>

Commands:
   clean            Clean up caches (brew, gem)
   dock             Apply macOS Dock settings
   edit             Open dotfiles in IDE (code) and Git GUI (stree)
   help             This help message
   macos            Apply macOS system defaults
   test             Run tests
   update           Update packages and pkg managers (OS, brew, npm, gem)

Customize/extend

You can put your custom settings, such as Git credentials in the system/.custom file which will be sourced from .zhsrc automatically. This file is in .gitignore.

Alternatively, you can have an additional, personal dotfiles repo at ~/.extra. The runcom .zhsrc sources all ~/.extra/runcom/*.sh files.

Additional resources

Credits

Many thanks to the dotfiles community.

License

These files are licensed under the MIT license except the following files which are taken from Mike McQuaid and are licensed under the GPLv3 license: