Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.28 KB

INSTALL.md

File metadata and controls

63 lines (48 loc) · 2.28 KB

Install

This repo is self-installing for consistent cross-machine configuration. See tutorial for more info.

Warning

Before installing use rm ~/.zshrc to delete the default ZSH profile. The installer will not overwrite any files, so if a ZSH profile exists it won't be able to link the one from dot files.

Run the install script below.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ACloudGuru/node-dev-dotfiles/trunk/install.sh)"

OR clone this repo and run it locally

gh repo clone ACloudGuru/node-dev-dotfiles $HOME/.dotfiles
. $HOME/.dotfiles/install.sh

Process

The install script will do the following:

  1. Clones the repo to $HOME/.dotfiles
  2. Set ZSH as default shell
  3. Installs Homebrew utility bundle, including apps:
  4. Links "stows" to $HOME folder, including:
    • A ZSH config file with sensible defaults
    • A script for storing shell secrets in Apple keychain
    • NPM config for setting token for private package
    • Yarn config for defaulting to use NPM token
    • ASDF config for legacy version file support

Shell Modules

Stow is used to link configs for tools that are required to be in the $HOME dir.

All paths in .dotfiles/config are linked as Stow packages by the install script.

Shell modules are installed and loaded by ZimFW for ZSH (the default shell on Mac OS).

If there's an issue loading plugins see manual installation guide.


Continue to SECRETS