Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xuehaipan/dev-setup
Automation scripts for setting up a basic development environment.
https://github.com/xuehaipan/dev-setup
dotfiles setup-development-environment setup-linux setup-macos setup-script vimrc vscode-settings zshrc
Last synced: 2 days ago
JSON representation
Automation scripts for setting up a basic development environment.
- Host: GitHub
- URL: https://github.com/xuehaipan/dev-setup
- Owner: XuehaiPan
- License: mit
- Created: 2019-11-03T10:20:40.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-03T13:35:59.000Z (21 days ago)
- Last Synced: 2025-01-15T02:28:30.209Z (9 days ago)
- Topics: dotfiles, setup-development-environment, setup-linux, setup-macos, setup-script, vimrc, vscode-settings, zshrc
- Language: Shell
- Homepage:
- Size: 17.9 MB
- Stars: 84
- Watchers: 5
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dev-Setup
[δΈζη](README.zh-CN.md) π
Automation scripts for setting up a basic development environment. ([screenshots](#screenshots))
## Table of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Rollback](#rollback)
- [Upgrade Packages](#upgrade-packages)
- [Font Settings](#font-settings)
- [Customization](#customization)
- [Packages](#packages)
- [Screenshots](#screenshots)
## Usage
### Installation
Download the script file using [wget](https://www.gnu.org/software/wget) / [curl](https://curl.haxx.se) / [git](https://git-scm.com) or any browser ([click here to download zip](https://codeload.github.com/XuehaiPan/Dev-Setup/zip/HEAD)). Open `Terminal` and run:
**via wget**
```bash
# Download and run via wget
/bin/bash -c "$(wget -O - https://github.com/XuehaiPan/Dev-Setup/raw/HEAD/setup.sh)"
```
**via curl**
```bash
# Download and run via curl
/bin/bash -c "$(curl -fL https://github.com/XuehaiPan/Dev-Setup/raw/HEAD/setup.sh)"
```
**via git or browser**
```bash
# Download via git
git clone --depth=1 https://github.com/XuehaiPan/Dev-Setup.git
# Run the script file
cd Dev-Setup
/bin/bash setup.sh
```
Options:
- `SET_MIRRORS` (default `false`): set the source of package managers to open source mirrors at [TUNA (@China)](https://mirrors.tuna.tsinghua.edu.cn) to speed up downloading. (see [Packages](#packages) for more details). If you want to bypass the prompt, run:
```bash
# Bypass the prompt
SET_MIRRORS=true bash setup.sh # set mirrors to TUNA (@China) (recommended for users in China)
SET_MIRRORS=false bash setup.sh # do not modify mirror settings
```
**Note**: If you are using **WSL on Windows**, you need to run [Windows Terminal](https://github.com/Microsoft/Terminal) as **administrator** to get the permissions to copy fonts to `C:\Windows\Fonts`. Otherwise, the fonts will not be installed successfully on Windows. You can download them from [nerdfonts.com](https://www.nerdfonts.com) and install them manually. See [Font Settings](#font-settings) for more details.
After running the script, all the old configuration files involved will be backed up to the folder `${HOME}/.dotfiles/backups/`, and a symbolic link `${HOME}/.dotfiles/backups/latest` will link to the latest one. You can compare the differences using:
```bash
# Compare the differences
colordiff -uEB ~/.dotfiles/backups/latest ~/.dotfiles
colordiff -uEB ~/.dotfiles/backups/latest/.dotfiles ~/.dotfiles
# Ignore miscellaneous directories
colordiff -uEB -x 'backups' -x '.dotfiles' ~/.dotfiles/backups/latest ~/.dotfiles
colordiff -uEB -x 'backups' ~/.dotfiles/backups/latest/.dotfiles ~/.dotfiles
```
There is a nice way to inspect and move changes from one version to another version of the same file using [`vimdiff`](https://www.vim.org) or [`meld`](http://meldmerge.org). Run:
```bash
# Inspect and move changes using vimdiff
vim -c "DirDiff ~/.dotfiles ~/.dotfiles/backups/latest/.dotfiles"
```
You can get vimdiff reference manual from [https://vimhelp.org/diff.txt.html](https://vimhelp.org/diff.txt.html), or type command `:help diff` inside Vim.
### Rollback
You can rollback to your previous dotfiles using:
```bash
# Rollback to the latest backup in "${HOME}/.dotfiles/backups/latest"
bash restore_dotfiles.sh
# Rollback to a specific version
bash restore_dotfiles.sh "${HOME}/.dotfiles/backups/"
```
**Note**: the packages installed by [`setup.sh`](setup.sh) (see [Packages](#packages)) will remain in your system.
### Upgrade Packages
You can upgrade your packages just by running:
```bash
upgrade_packages
```
By default, `upgrade_packages` will not upgrade your conda environments. If you want to always keep your conda up-to-date, you can uncomment the corresponding line in `${HOME}/.dotfiles/utilities.sh`. Or run the script as:
```bash
upgrade_packages; upgrade_conda
```
### Font Settings
The login shell for the current user will be set to **`zsh`**. In order to get a wonderful and enjoyable terminal experience, please change your terminal font to a [**Nerd Font**](https://github.com/ryanoasis/nerd-fonts). You can download any nerd font you like from [nerdfonts.com](https://www.nerdfonts.com) manually. The script will download and install [**`DejaVu Sans Mono Nerd Font`**](https://github.com/ryanoasis/nerd-fonts/blob/HEAD/patched-fonts/DejaVuSansMono) for **macOS**, **Linux** and **Windows** (**administrator privilege** is required to install fonts on Windows).
Configure your terminal to use nerd fonts:
- For macOS and Linux users, change the terminal font setting to "Nerd Font Complete" (e.g. `'DejaVuSansM Nerd Font Book'`).
- For WSL on Windows users, change the terminal font setting to "Nerd Font Complete Windows Compatible" (e.g. `'DejaVuSansMono NF'`).
See [Font configurations for Powerlevel10k](https://github.com/romkatv/powerlevel10k#fonts) for more details.
Or use Zsh with Powerlevel10k Lean style:
```bash
chsh -s /usr/local/bin/zsh-lean # change the login shell
```
which do not need additional font settings.
**Note**: If you are using **WSL on Windows**, you need to run [Windows Terminal](https://github.com/Microsoft/Terminal) as **administrator** to get the permissions to copy fonts to `C:\Windows\Fonts`. If you forgot to obtain the appropriate privileges, you can open WSL in a new terminal window with administrator privilege. Then run the following command:
```bash
find -L ~/.local/share/fonts -not -empty -type f -name '*.tt[fc]' -print0 | xargs -0 -I '{}' bash -c \
'file="{}"
font=${file##*/}
echo "Installing \"${font}\" to \"/mnt/c/Windows/Fonts\""
cp -f "${file}" /mnt/c/Windows/Fonts
/mnt/c/Windows/System32/reg.exe add "HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts" \
/v "${font%.tt[fc]} (TrueType)" /t REG_SZ /d "${font}" /f'
```
## Customization
Make your own setup scripts. Add a new config file to the script:
1. fork this repository;
2. copy the contents of your config file to a temp file `temp.txt`;
3. replace all identifiers of your home directory with `${HOME}` in `temp.txt`;
4. replace all identifiers of your user name with `${USER}` in `temp.txt`;
5. replace all `\` with `\\` in `temp.txt`;
6. replace all `$` with `\$` in `temp.txt`;
7. add the following lines to script `setup_.sh`:
```bash
cd "${HOME}" # this line has already been added at the top of the script
# Replace with the config file's name
backup_dotfiles .dotfiles/
cat >.dotfiles/ < .
```
8. add `` and `.dotfiles/` to `DOTFILES` in [`restore_dotfiles.sh`](restore_dotfiles.sh#L12).
## Packages
The source of package managers (Homebrew (macOS), APT (Ubuntu), Pacman (Manjaro), CPAN, Gem, Conda and Pip) will be set to the open source mirrors at [TUNA (@China)](https://mirrors.tuna.tsinghua.edu.cn).
The following packages will be setup:
| Package | macOS | Ubuntu Linux | Manjaro Linux |
| :------------------------------------------------------------------------------------------------------------------------------- | :---: | :----------: | :-----------: |
| [Mirrors at TUNA (@China)](https://mirrors.tuna.tsinghua.edu.cn) | β | β | β |
| [Homebrew](https://brew.sh) | β | β | β |
| | | | |
| [bash](https://www.gnu.org/software/bash) | β | β | β |
| [bash-completion](https://salsa.debian.org/debian/bash-completion) | β | β | β |
| [zsh](http://zsh.sourceforge.net) & [oh-my-zsh](https://ohmyz.sh) | β | β | β |
| [powerlevel10k](https://github.com/romkatv/powerlevel10k) | β | β | β |
| [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) | β | β | β |
| [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) | β | β | β |
| [zsh-completions](https://github.com/zsh-users/zsh-completions) | β | β | β |
| [colorls](https://github.com/athityakumar/colorls) | β | β | β |
| | | | |
| [git](https://git-scm.com) & [git-lfs](https://git-lfs.github.com) | β | β | β |
| [vim](https://www.vim.org) & [vim-plug](https://github.com/junegunn/vim-plug) | β | β | β |
| [tmux](https://github.com/tmux/tmux/wiki) & [oh-my-tmux](https://github.com/gpakosz/.tmux) | β | β | β |
| [reattach-to-user-namespace](https://github.com/ChrisJohnsen/tmux-MacOSX-pasteboard) / [xclip](https://github.com/astrand/xclip) | β | β | β |
| | | | |
| [fzf](https://github.com/junegunn/fzf) | β | β | β |
| [ranger](https://ranger.github.io) | β | β | β |
| [fd](https://github.com/sharkdp/fd) | β | β | β |
| [bat](https://github.com/sharkdp/bat) | β | β | β |
| [highlight](http://www.andre-simon.de/doku/highlight/en/highlight.php) | β | β | β |
| [ripgrep](https://github.com/BurntSushi/ripgrep) | β | β | β |
| | | | |
| [wget](https://www.gnu.org/software/wget) | β | β | β |
| [curl](https://curl.haxx.se) | β | β | β |
| [openssh](https://www.ssh.com/ssh/openssh) | β | β | β |
| [ruby](https://www.ruby-lang.org/en) & [rubygems](https://rubygems.org) | β | β | β |
| [perl](https://www.perl.org) & [cpan](https://www.cpan.org) | β | β | β |
| [htop](https://hisham.hm/htop) | β | β | β |
| [net-tools](https://sourceforge.net/projects/net-tools) | β | β | β |
| [atool](https://www.nongnu.org/atool/) | β | β | β |
| [tree](http://mama.indstate.edu/users/ice/tree/) | β | β | β |
| [git-extras](https://github.com/tj/git-extras) | β | β | β |
| [diffutils](https://www.gnu.org/software/diffutils) | β | β | β |
| [colordiff](https://www.colordiff.org) | β | β | β |
| [diff-so-fancy](https://github.com/so-fancy/diff-so-fancy) | β | β | β |
| [jq](https://stedolan.github.io/jq) | β | β | β |
| [shfmt](https://github.com/mvdan/sh) | β | β | β |
| [shellcheck](https://www.shellcheck.net) | β | β | β |
| | | | |
| [Miniconda3](https://docs.conda.io/en/latest/miniconda.html) | β | β | β |
| [mamba](https://github.com/mamba-org/mamba) | β | β | β |
| [gcc](https://gcc.gnu.org) | β | β | β |
| [gdb](https://www.gnu.org/software/gdb) | β | β | β |
| [clang](https://clang.llvm.org) & [llvm](https://llvm.org) | β | β | β |
| [lldb](http://lldb.llvm.org) | β | β | β |
| [make](https://www.gnu.org/software/make) | β | β | β |
| [cmake](https://cmake.org) | β | β | β |
| [automake](https://www.gnu.org/software/automake) | β | β | β |
| [autoconf](https://www.gnu.org/software/autoconf) | β | β | β |
| | | | |
| [DejaVu Sans Mono Nerd Font](https://github.com/ryanoasis/nerd-fonts/blob/HEAD/patched-fonts/DejaVuSansMono) | β | β | β |
| [Cascadia Code Font](https://github.com/microsoft/cascadia-code) | β | β | β |
| [Menlo Font](https://github.com/XuehaiPan/Dev-Setup/blob/HEAD/fonts) | β | β | β |
| [Microsoft YaHei Mono Font](https://github.com/XuehaiPan/Dev-Setup/blob/HEAD/fonts) | β | β | β |
Currently macOS only casks installed by Homebrew:
| Package | Description | macOS | Ubuntu / Manjaro Linux |
| :-------------------------------------------------------- | ------------------------------------------------------------------------------------------ | :---: | :--------------------: |
| [iTerm2](https://iterm2.com) | A terminal emulator for macOS that does amazing things | β | β |
| [Google Chrome](https://www.google.com/chrome/index.html) | A fast, secure, and free web browser built for the modern web | β | β |
| [Keka](https://www.keka.io) | The macOS file archiver | β | β |
| [IINA](https://iina.io) | The modern media player for macOS | β | β |
| [Typora](https://typora.io) | A truly minimal markdown editor | β | β |
| [Visual Studio Code](https://code.visualstudio.com) | A lightweight but powerful source code editor | β | β |
| [XQuartz](https://www.xquartz.org) | An open-source effort to develop a version of the X.Org X Window System that runs on macOS | β | β |
## Screenshots
Shell:
tmux:
fzf:
Vim:
Live markdown preview support for Vim:
