dotfiles README

The project's README from github.com/mathiasbynens/dotfiles. As one markdown file: README.md.

Mathias’s dotfiles

Screenshot of my shell prompt

Installation

Warning: If you want to give these dotfiles a try, 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 that entails. Use at your own risk!

Using Git and the bootstrap script

You can clone the repository wherever you want. (I like to keep it in ~/Projects/dotfiles, with ~/dotfiles as a symlink.) The bootstrapper script will pull in the latest version and copy the files to your home folder.

git clone https://github.com/mathiasbynens/dotfiles.git && cd dotfiles && source bootstrap.sh

To update, cd into your local dotfiles repository and then:

source bootstrap.sh

Alternatively, to update while avoiding the confirmation prompt:

set -- -f; source bootstrap.sh

Git-free install

To install these dotfiles without Git:

cd; curl -#L https://github.com/mathiasbynens/dotfiles/tarball/main | tar -xzv --strip-components 1 --exclude={README.md,bootstrap.sh,.osx,LICENSE-MIT.txt}

To update later on, just run that command again.

Specify the $PATH

If ~/.path exists, it will be sourced along with the other files, before any feature testing (such as detecting which version of ls is being used) takes place.

Here’s an example ~/.path file that adds /usr/local/bin to the $PATH:

export PATH="/usr/local/bin:$PATH"

Add custom commands without creating a new fork

If ~/.extra exists, it will be sourced along with the other files. You can use this to add a few custom commands without the need to fork this entire repository, or to add commands you don’t want to commit to a public repository.

My ~/.extra looks something like this:

# Git credentials
# Not in the repository, to prevent people from accidentally committing under my name
GIT_AUTHOR_NAME="Mathias Bynens"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="[email protected]"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"

You could also use ~/.extra to override settings, functions and aliases from my dotfiles repository. It’s probably better to fork this repository instead, though.

Sensible macOS defaults

When setting up a new Mac, you may want to set some sensible macOS defaults:

./.macos

Install Homebrew formulae

When setting up a new Mac, you may want to install some common Homebrew formulae (after installing Homebrew, of course):

./brew.sh

Some of the functionality of these dotfiles depends on formulae installed by brew.sh. If you don’t plan to run brew.sh, you should look carefully through the script and manually install any particularly important ones. A good example is Bash/Git completion: the dotfiles use a special version from Homebrew.

Feedback

Suggestions/improvements welcome!

Author

twitter/mathias
Mathias Bynens

Thanks to…

dotfiles (mathiasbynens/dotfiles)

Searching Database…

31.5K ·GitHub
Dotfiles
Что это такое?Личные dotfiles Матиаса Биненса: файлы конфигурации shell для macOS (алиасы, функции, настройки), а также скрипты для настройки нового Mac с разумными значениями по умолчанию.
То есть это не приложение — что именно я получу после установки?Обычные файлы, которые копируются в вашу домашнюю папку и подхватываются вашим shell, плюс три скрипта: bootstrapper (устанавливает и обновляет файлы), ~/.macos с разумными системными настройками macOS и brew.sh для распространённых формул Homebrew.
Как настроить это на моём Mac?Сделайте форк репозитория и сначала изучите код. Затем клонируйте его куда угодно и запустите bootstrap-скрипт — он скопирует файлы в вашу домашнюю папку. Как альтернатива есть команда установки без использования git.
Всё будет работать на чистом Mac, или нужен ещё и Homebrew?Часть функциональности зависит от формул Homebrew, которые устанавливает входящий в комплект brew.sh — например, автодополнение для Bash/Git использует специальную версию из Homebrew. Если пропустите brew.sh, посмотрите скрипт и установите важные формулы вручную.
Можно просто запустить это на своей машине как есть?Автор просит так не делать: сначала сделайте форк репозитория, просмотрите код и удалите всё, что вам не нужно или не пригодится. Это его личные настройки, и пользуетесь вы ими на свой страх и риск.
Где автор держит свою копию репозитория?Где угодно — он хранит её в ~/Projects/dotfiles и делает в неё символическую ссылку ~/dotfiles.
Как обновить dotfiles потом?Перейдите через cd в свою локальную копию репозитория dotfiles и снова запустите bootstrap-скрипт — он подтянет последнюю версию и заново скопирует файлы. Установка без git обновляется так же: просто запустите ту же команду ещё раз.
Могу ли я добавить свои алиасы, не форкая весь репозиторий?Да — есть два необязательных файла: ~/.path, который подхватывается раньше всех для расширения $PATH, и ~/.extra, который подхватывается вместе с остальными — для своих команд или чтобы переопределить функции и алиасы из репозитория. Впрочем, автор считает, что форк, скорее всего, лучше.
What are similar projects?direnv, awesome-dotfiles, oh-my-fish, tpm, oh-my-posh, dotfiles, .tmux, tmuxinator
Which topics is it in?click, tweaks, dotfiles, script, prompt, configuration, bash, homebrew, git, shell, customization, terminal
Creator
mathiasbynens
Size
0.8 MB
Stars
31.5K
Updated
CommitApr 09
Age
15y
Commits · 90 Days