install.sh 7.26 KB
Newer Older
1
#!/bin/sh
2
3
4
5
6
7
#
# This script should be run via curl:
#   sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
# or wget:
#   sh -c "$(wget -qO- https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
#
8
9
10
11
# As an alternative, you can first download the install script and run it afterwards:
#   wget https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh
#   sh install.sh
#
Marc Cornellà's avatar
Marc Cornellà committed
12
13
14
# You can tweak the install behavior by setting variables when running the script. For
# example, to change the path to the Oh My Zsh repository:
#   ZSH=~/.zsh sh install.sh
15
#
Marc Cornellà's avatar
Marc Cornellà committed
16
# Respects the following environment variables:
17
#   ZSH     - path to the Oh My Zsh repository folder (default: $HOME/.oh-my-zsh)
18
#   REPO    - name of the GitHub repo to install from (default: robbyrussell/oh-my-zsh)
19
20
#   REMOTE  - full remote URL of the git repo to install (default: GitHub via HTTPS)
#   BRANCH  - branch to check out immediately after install (default: master)
21
#
22
# Other options:
23
24
#   CHSH    - 'no' means the installer will not change the default shell (default: yes)
#   RUNZSH  - 'no' means the installer will not run zsh after the install (default: yes)
25
#
26
27
28
29
30
31
# You can also pass some arguments to the install script to set some these options:
#   --skip-chsh: has the same behavior as setting CHSH to 'no'
#   --unattended: sets both CHSH and RUNZSH to 'no'
# For example:
#   sh install.sh --unattended
#
32
33
set -e

34
# Default settings
35
ZSH=${ZSH:-~/.oh-my-zsh}
36
REPO=${REPO:-robbyrussell/oh-my-zsh}
37
REMOTE=${REMOTE:-https://github.com/${REPO}.git}
38
39
BRANCH=${BRANCH:-master}

40
41
# Other options
CHSH=${CHSH:-yes}
42
RUNZSH=${RUNZSH:-yes}
43
44


45
command_exists() {
46
	command -v "$@" >/dev/null 2>&1
47
48
}

49
error() {
50
	echo ${RED}"Error: $@"${RESET} >&2
51
52
}

53
54
# Set up color sequences
setup_color() {
55
56
	if command_exists tput; then
		ncolors=$(tput colors)
57
58
	else
		ncolors=0
59
	fi
60

61
62
	# Only use colors if connected to a terminal that supports them
	if [ -t 1 ] && [ $ncolors -ge 8 ]; then
63
64
65
66
67
		RED="$(tput setaf 1)"
		GREEN="$(tput setaf 2)"
		YELLOW="$(tput setaf 3)"
		BLUE="$(tput setaf 4)"
		BOLD="$(tput bold)"
68
		RESET="$(tput sgr0)"
69
	else
70
71
72
73
74
75
		RED=$(printf '\033[31m')
		GREEN=$(printf '\033[32m')
		YELLOW=$(printf '\033[33m')
		BLUE=$(printf '\033[34m')
		BOLD=$(printf '\033[1m')
		RESET=$(printf '\033[m')
76
	fi
77
}
78

79
setup_ohmyzsh() {
80
81
82
83
84
85
	# Prevent the cloned repository from having insecure permissions. Failing to do
	# so causes compinit() calls to fail with "command not found: compdef" errors
	# for users with insecure umasks (e.g., "002", allowing group writability). Note
	# that this will be ignored under Cygwin by default, as Windows ACLs take
	# precedence over umasks except for filesystems mounted with option "noacl".
	umask g-w,o-w
86

87
	echo "${BLUE}Cloning Oh My Zsh...${RESET}"
88

89
	command_exists git || {
90
		error "git is not installed"
91
92
		exit 1
	}
93
94

	if [ "$OSTYPE" = cygwin ] && git --version | grep -q msysgit; then
95
96
		error "Windows/MSYS Git is not supported on Cygwin"
		error "Make sure the Cygwin git package is installed and is first on the \$PATH"
97
		exit 1
98
	fi
99

100
	git clone --depth=1 --branch "$BRANCH" "$REMOTE" "$ZSH" || {
101
		error "git clone of oh-my-zsh repo failed"
102
103
		exit 1
	}
104
105

	echo
106
}
Toon Claes's avatar
Toon Claes committed
107

108
setup_zshrc() {
109
110
111
	# Keep most recent old .zshrc at .zshrc.pre-oh-my-zsh, and older ones
	# with datestamp of installation that moved them aside, so we never actually
	# destroy a user's original zshrc
112
	echo "${BLUE}Looking for an existing zsh config...${RESET}"
113
114
115

	# Must use this exact name so uninstall.sh can find it
	OLD_ZSHRC=~/.zshrc.pre-oh-my-zsh
116
	if [ -f ~/.zshrc ] || [ -h ~/.zshrc ]; then
117
118
119
120
121
122
123
124
125
126
127
128
129
130
		if [ -e "$OLD_ZSHRC" ]; then
			OLD_OLD_ZSHRC="${OLD_ZSHRC}-$(date +%Y-%m-%d_%H-%M-%S)"
			if [ -e "$OLD_OLD_ZSHRC" ]; then
				error "$OLD_OLD_ZSHRC exists. Can't back up ${OLD_ZSHRC}"
				error "re-run the installer again in a couple of seconds"
				exit 1
			fi
			mv "$OLD_ZSHRC" "${OLD_OLD_ZSHRC}"

			echo "${YELLOW}Found old ~/.zshrc.pre-oh-my-zsh." \
				"${GREEN}Backing up to ${OLD_OLD_ZSHRC}${RESET}"
		fi
		echo "${YELLOW}Found ~/.zshrc.${RESET} ${GREEN}Backing up to ${OLD_ZSHRC}${RESET}"
		mv ~/.zshrc "$OLD_ZSHRC"
131
	fi
Robby Russell's avatar
Robby Russell committed
132

133
	echo "${GREEN}Using the Oh My Zsh template file and adding it to ~/.zshrc.${RESET}"
134

135
136
137
138
139
	cp "$ZSH/templates/zshrc.zsh-template" ~/.zshrc
	sed "/^export ZSH=/ c\\
export ZSH=\"$ZSH\"
" ~/.zshrc > ~/.zshrc-omztemp
	mv -f ~/.zshrc-omztemp ~/.zshrc
140
141

	echo
142
}
Robby Russell's avatar
Robby Russell committed
143

144
setup_shell() {
145
	# Skip setup if the user wants or stdin is closed (not running interactively).
146
	if [ $CHSH = no ]; then
147
148
149
		return
	fi

150
151
152
153
154
155
156
157
158
	# If this user's login shell is already "zsh", do not attempt to switch.
	if [ "$(basename "$SHELL")" = "zsh" ]; then
		return
	fi

	# If this platform doesn't provide a "chsh" command, bail out.
	if ! command_exists chsh; then
		cat <<-EOF
			I can't change your shell automatically because this system does not have chsh.
159
			${BLUE}Please manually change your default shell to zsh${RESET}
160
161
162
163
		EOF
		return
	fi

164
	echo "${BLUE}Time to change your default shell to zsh:${RESET}"
165
166
167
168
169
170
171
172
173
174
175

	# Test for the right location of the "shells" file
	if [ -f /etc/shells ]; then
		shells_file=/etc/shells
	elif [ -f /usr/share/defaults/etc/shells ]; then # Solus OS
		shells_file=/usr/share/defaults/etc/shells
	else
		error "could not find /etc/shells file. Change your default shell manually."
		return
	fi

176
177
178
179
180
	# Get the path to the right zsh binary
	# 1. Use the most preceding one based on $PATH, then check that it's in the shells file
	# 2. If that fails, get a zsh path from the shells file, then check it actually exists
	if ! zsh=$(which zsh) || ! grep -qx "$zsh" "$shells_file"; then
		if ! zsh=$(grep '^/.*/zsh$' "$shells_file" | tail -1) || [ ! -f "$zsh" ]; then
181
182
			error "no zsh binary found or not present in '$shells_file'"
			error "change your default shell manually."
183
184
185
186
187
188
			return
		fi
	fi

	# Actually change the default shell to zsh
	if ! chsh -s "$zsh"; then
189
		error "chsh command unsuccessful. Change your default shell manually."
190
191
192
	else
		export SHELL="$zsh"
		echo "${GREEN}Shell successfully changed to '$zsh'.${RESET}"
193
	fi
194
195

	echo
196
197
198
}

main() {
199
	# Run as unattended if stdin is closed
200
201
202
203
204
	if [ ! -t 0 ]; then
		RUNZSH=no
		CHSH=no
	fi

205
206
207
	# Parse arguments
	while [ $# -gt 0 ]; do
		case $1 in
208
			--unattended) RUNZSH=no; CHSH=no ;;
209
210
211
212
213
			--skip-chsh) CHSH=no ;;
		esac
		shift
	done

214
215
216
	setup_color

	if ! command_exists zsh; then
217
		echo "${YELLOW}Zsh is not installed.${RESET} Please install zsh first."
218
219
220
221
222
		exit 1
	fi

	if [ -d "$ZSH" ]; then
		cat <<-EOF
223
			${YELLOW}You already have Oh My Zsh installed.${RESET}
224
			You'll need to remove '$ZSH' if you want to reinstall.
225
226
227
228
229
230
231
		EOF
		exit 1
	fi

	setup_ohmyzsh
	setup_zshrc
	setup_shell
Robby Russell's avatar
Robby Russell committed
232

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
	printf "$GREEN"
	cat <<-'EOF'
		         __                                     __
		  ____  / /_     ____ ___  __  __   ____  _____/ /_
		 / __ \/ __ \   / __ `__ \/ / / /  /_  / / ___/ __ \
		/ /_/ / / / /  / / / / / / /_/ /    / /_(__  ) / / /
		\____/_/ /_/  /_/ /_/ /_/\__, /    /___/____/_/ /_/
		                        /____/                       ....is now installed!


		Please look over the ~/.zshrc file to select plugins, themes, and options.

		p.s. Follow us on https://twitter.com/ohmyzsh

		p.p.s. Get stickers, shirts, and coffee mugs at https://shop.planetargon.com/collections/oh-my-zsh

	EOF
250
	printf "$RESET"
251

252
	if [ $RUNZSH = no ]; then
253
254
255
256
		echo "${YELLOW}Run zsh to try it out.${RESET}"
		exit
	fi

257
	exec zsh -l
258
259
}

260
main "$@"