npx skills add nateberkopec/dotfilesREADME
Dotfiles
Set up a fresh Mac with one command.
Most dotfiles repos just copy files to your home folder. This one does more. It installs apps, sets system settings, and gets your whole dev setup ready to go.
What It Does
- Installs Homebrew and packages from Brewfile
- Sets up SSH keys
- Installs apps and fonts
- Sets Fish as your default shell
- Syncs config files to your home folder
- Sets macOS defaults (Dock, trackpad, screenshots, and more)
Installation
Clone this repo:
git clone https://github.com/nateberkopec/dotfiles.git ~/.dotfiles
Run the setup:
cd ~/.dotfiles
./bin/dotf run
For verbose output:
DEBUG=true ./bin/dotf run
Commands
| Command | What it does |
|---|---|
dotf run | Set up your Mac. Safe to run many times. |
dotf update | Pull config changes from your system back into this repo |
dotf help | Show help |
How It Works
The setup runs in Steps. Each Step is a Ruby class that does one thing: install Homebrew, set up Fish, sync config files, etc.
Steps can depend on other steps. The system runs them in the right order.
Available Steps
See lib/dotfiles/steps/ for all steps.
Adding Your Own Steps
See docs/implementing-steps.md to learn how.
Project Layout
bin/ CLI tool
lib/dotfiles/ Core code and steps
files/ Config files to sync to home folder
docs/ Docs for contributors
test/ Test suite
Brewfile Homebrew packages to install
Contributing
- Fork this repo
- Create a branch for your change
- Run the tests:
rake test - Open a pull request
Publisher
Statistics
Stars62
Forks2
Open Issues0
CreatedOct 29, 2021