Skip to main content Skip to docs navigation
Check
View on GitHub

Getting started

Simplify the complex dotfiles repository wiring by separating the files from the management layer, use a dedicatd CLI utility to control all aspects of the dotfiles repository with ease.

On this page

Requirements

  • A Unix-like operating system: macOS, Linux
  • git (recommended v2.30.0 or higher)

QuickStart

The fastest way (for macOS and Linux) to install dotfiles-cli is using Homebrew:

brew install ZachiNachshon/tap/dotfiles-cli

First Timers

Recommended commands order for initial setup:

  1. Clone and link a remote dotfiles repository:

    dotfiles link https://github.com/ZachiNachshon/dotfiles-example.git
    
  2. Create home/shell symlinks to $HOME folder:

    dotfiles sync all
    
  3. Install shell plugins:

    dotfiles plugins <bash/zsh>
    
  4. Update OS settings and preferences:

    dotfiles os <mac/linux>
    
  5. Install Homebrew components (might take time):

    dotfiles brew all