https://github.com/gabrielecanepa/dotfiles
My macOS configuration and preferences
https://github.com/gabrielecanepa/dotfiles
dotfiles dotfiles-mac git homebrew macos macos-setup oh-my-zsh zsh
Last synced: 11 months ago
JSON representation
My macOS configuration and preferences
- Host: GitHub
- URL: https://github.com/gabrielecanepa/dotfiles
- Owner: gabrielecanepa
- Created: 2019-06-09T17:44:02.000Z (almost 7 years ago)
- Default Branch: dotfiles
- Last Pushed: 2025-07-03T21:08:43.000Z (11 months ago)
- Last Synced: 2025-07-03T22:20:32.253Z (11 months ago)
- Topics: dotfiles, dotfiles-mac, git, homebrew, macos, macos-setup, oh-my-zsh, zsh
- Language: Shell
- Homepage:
- Size: 4.38 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
> [!WARNING]
> If you want to try the following dotfiles, you should first fork this repository, review the code and remove things you don’t want or need. **Don’t blindly use my settings** unless you know what you are doing. Use at your own risk!
## Installation
1. [SSH](#1-ssh)
2. [Homebrew](#2-homebrew)
3. [Oh My Zsh](#3-oh-my-zsh)
4. [Dotfiles](#4-dotfiles)
5. [Configuration](#5-configuration)
- [Shell profile](#shell-profile)
6. [Languages and dependencies](#6-languages-and-dependencies)
- [Node.js](#nodejs)
- [Ruby](#ruby)
- [Python](#python)
7. [VSCode](#7-vscode)
- [Settings, snippets and extensions](#settings-snippets-and-extensions)
- [Keybindings](#keybindings)
8. [Assets](#8-resources)
- [Fonts](#fonts)
- [iCloud](#icloud)
### 1. SSH
If not already present, generate a new SSH key and copy it to the clipboard:
```sh
ssh-keygen -t ed25519 -C ""
tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy
```
Add the key to [GitHub](https://github.com/settings/ssh/new), [GitLab](https://gitlab.com/-/profile/keys) and any other services you use.
### 2. Homebrew
Install [Homebrew](https://brew.sh):
```sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
### 3. Oh My Zsh
Install [Oh My Zsh](https://ohmyz.sh) and some essential plugins from [zsh-users](https://github.com/zsh-users):
```sh
/bin/bash -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/HEAD/tools/install.sh)"
for plugin in zsh-autosuggestions zsh-completions zsh-syntax-highlighting; do
git clone https://github.com/zsh-users/${plugin}.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/${plugin}
done
# Restart
zsh
```
### 4. Dotfiles
Clone this repository:
```sh
gh repo clone gabrielecanepa/dotfiles
# or
git clone git@github.com:gabrielecanepa/dotfiles.git
```
Copy the files to your home directory, manually or in bulk.
> [!WARNING]
> The following bulk operation will overwrite all existing files in your home directory. Existing files will be backed up in `~/.bak`.
```sh
cd dotfiles
bak=$(mkdir -p ~/.bak/dotfiles/$(date +%Y%m%d) && echo $_)
for config in $(ls -A); do
[[ -e ~/$config ]] && cp -fr ~/$config $bak
cp -fr $config ~/$config
done
```
Install the packages listed in the [Brewfile](/.Brewfile):
```sh
brew bundle --file ~/.Brewfile
```
### 5. Configuration
#### Shell profile
Use the custom [`profile` plugin](/.zsh/plugins/profile/profile.plugin.zsh) to create your shell profile with a guided prompt:
```sh
profile install
```
#### Environment variables
Copy the `.env.example` file to `.env` and fill in the environment-specific values you need:
```sh
cp ~/.env.example ~/.env
```
### 6. Languages and dependencies
#### Node.js
Install the [Node.js](https://nodejs.org) version in use with [nodenv](https://github.com/nodenv/nodenv) and all saved global packages:
```sh
nodenv install $(cat ~/.node_version) --skip-existing
npm -g install
```
Link the nodeenv version to the tracked one:
```sh
nodenv global $(cat ~/.node-version)
rm -f $NODENV_ROOT/version && ln -sf ~/.node-version $NODENV_ROOT/version
```
#### Ruby
Install and link the [Ruby](https://ruby-lang.org) version in use with [rbenv](https://github.com/rbenv/rbenv):
```sh
rbenv install $(cat ~/.ruby-version) --skip-existing
rm -f $RBENV_ROOT/version && ln -sf ~/.ruby-version $RBENV_ROOT/version
```
#### Python
Install and link the [Python](https://python.org) version in use with [pyenv](https://github.com/pyenv/pyenv):
```sh
pyenv install $(cat ~/.python-version) --skip-existing
rm -f $PYENV_ROOT/version && ln -sf ~/.python-version $PYENV_ROOT/version
```
### 7. VSCode
#### Settings, snippets and extensions
Use symlinks to backup keybindings, settings, snippets and extensions.
> [!WARNING]
> The following operations will permanently replace some system folders with symlinks to the corresponding files in the repository. Make sure to back up your data before proceeding.
```sh
for config in keybindings.json settings.json snippets; do
file=~/Library/Application\ Support/Code/User/$config
rm -rf $file
ln -sf ~/.vscode/user/$config $file
done
rm -rf ~/.vscode/extensions/extensions.json
ln -sf ~/.vscode/user/extensions.json ~/.vscode/extensions/extensions.json
```
#### Keybindings
To avoid emitting beeps in Electron-based applications when using the keyboard combinations `^⌘←`, `^⌘↓` and `^⌘` (see https://github.com/electron/electron/issues/2617) create the keybinding settings file:
```sh
[[ ! -d ~/Library/KeyBindings ]] && mkdir ~/Library/KeyBindings
touch ~/Library/KeyBindings/DefaultKeyBinding.dict
```
And populate it with the following content:
```
{
"^@\UF701" = "noop";
"^@\UF702" = "noop";
"^@\UF703" = "noop";
}
```
### 8. Assets
#### Fonts
To display icons in your terminal, download a font supporting [Nerd Fonts](https://nerdfonts.com), like [Monaco](https://github.com/Karmenzind/monaco-nerd-fonts/tree/master/fonts). Activate the fonts in apps supporting command line interfaces (Terminal, iTerm, VSCode, etc).
#### iCloud
Use the following script to:
- Replace the home `Downloads`, `Movies` and `Music` folders with a symbolic link to the corresponding (new or existing) folder on iCloud. This grants continuous synchronization between the cloud and your local machine.
- Replace the home `Applications` folder with a symlink to the system applications folder.
- Create a symlink named `iCloud`, pointing to the related cloud folder, in `Applications`, `Developer` and `Pictures`.
> [!WARNING]
> The following operations will permanently replace some system folders with symbolic links to iCloud Drive. Make sure to back up your data before proceeding.
```sh
for folder in Applications Developer Downloads Movies Music Pictures; do
# Create the folder in iCloud Drive if it doesn't exist.
cloud_folder=~/Library/Mobile\ Documents/com~apple~CloudDocs/$folder
[[ ! -d $cloud_folder ]] && mkdir $cloud_folder
case $folder in
# Replace with a symlink to the system folder.
Applications)
rm -rf ~/Applications
ln -sf /Applications ~/Applications
ln -sf $cloud_folder /Applications/iCloud
;;
# Create a symlink named `iCloud`.
Developer|Pictures)
ln -sf $cloud_folder ~/$folder/iCloud
;;
# Replace with a symlink to the cloud folder.
Downloads|Movies|Music)
[[ -d ~/$folder ]] && mv ~/$folder/* $cloud_folder 2>/dev/null
rm -rf ~/$folder && ln -sf $cloud_folder ~/$folder
;;
esac
done
```
The new folder icons can be replaced manually with the system icons stored here:
```sh
open /System/Library/Extensions/IOStorageFamily.kext/Contents/Resources
```