install.sh 8.7 KB
Newer Older
1
#!/bin/sh
2
3
#
# This script should be run via curl:
4
#   sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
5
# or via wget:
6
#   sh -c "$(wget -qO- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
7
8
# or via fetch:
#   sh -c "$(fetch -o - https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
9
#
10
# As an alternative, you can first download the install script and run it afterwards:
11
#   wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
12
13
#   sh install.sh
#
Marc Cornellà's avatar
Marc Cornellà committed
14
15
16
# 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
17
#
Marc Cornellà's avatar
Marc Cornellà committed
18
# Respects the following environment variables:
19
#   ZSH     - path to the Oh My Zsh repository folder (default: $HOME/.oh-my-zsh)
20
#   REPO    - name of the GitHub repo to install from (default: ohmyzsh/ohmyzsh)
21
22
#   REMOTE  - full remote URL of the git repo to install (default: GitHub via HTTPS)
#   BRANCH  - branch to check out immediately after install (default: master)
23
#
24
# Other options:
25
26
27
#   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)
#   KEEP_ZSHRC - 'yes' means the installer will not replace an existing .zshrc (default: no)
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'
32
#   --keep-zshrc: sets KEEP_ZSHRC to 'yes'
33
34
# For example:
#   sh install.sh --unattended
35
36
# or:
#   sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended
37
#
38
39
set -e

40
# Default settings
41
ZSH=${ZSH:-~/.oh-my-zsh}
42
REPO=${REPO:-ohmyzsh/ohmyzsh}
43
REMOTE=${REMOTE:-https://github.com/${REPO}.git}
44
45
BRANCH=${BRANCH:-master}

46
47
# Other options
CHSH=${CHSH:-yes}
48
RUNZSH=${RUNZSH:-yes}
49
KEEP_ZSHRC=${KEEP_ZSHRC:-no}
50
51


52
command_exists() {
53
	command -v "$@" >/dev/null 2>&1
54
55
}

56
error() {
57
	echo ${RED}"Error: $@"${RESET} >&2
58
59
}

60
61
62
63
underline() {
	echo "$(printf '\033[4m')$@$(printf '\033[24m')"
}

64
setup_color() {
65
66
	# Only use colors if connected to a terminal
	if [ -t 1 ]; then
67
68
69
70
71
72
		RED=$(printf '\033[31m')
		GREEN=$(printf '\033[32m')
		YELLOW=$(printf '\033[33m')
		BLUE=$(printf '\033[34m')
		BOLD=$(printf '\033[1m')
		RESET=$(printf '\033[m')
73
74
75
76
77
78
79
	else
		RED=""
		GREEN=""
		YELLOW=""
		BLUE=""
		BOLD=""
		RESET=""
80
	fi
81
}
82

83
setup_ohmyzsh() {
84
85
86
87
88
89
	# 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
90

91
	echo "${BLUE}Cloning Oh My Zsh...${RESET}"
92

93
	command_exists git || {
94
		error "git is not installed"
95
96
		exit 1
	}
97
98

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

104
105
106
107
108
	git clone -c core.eol=lf -c core.autocrlf=false \
		-c fsck.zeroPaddedFilemode=ignore \
		-c fetch.fsck.zeroPaddedFilemode=ignore \
		-c receive.fsck.zeroPaddedFilemode=ignore \
		--depth=1 --branch "$BRANCH" "$REMOTE" "$ZSH" || {
109
		error "git clone of oh-my-zsh repo failed"
110
111
		exit 1
	}
112
113

	echo
114
}
Toon Claes's avatar
Toon Claes committed
115

116
setup_zshrc() {
117
118
119
	# 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
120
	echo "${BLUE}Looking for an existing zsh config...${RESET}"
121
122
123

	# Must use this exact name so uninstall.sh can find it
	OLD_ZSHRC=~/.zshrc.pre-oh-my-zsh
124
	if [ -f ~/.zshrc ] || [ -h ~/.zshrc ]; then
125
126
127
128
129
		# Skip this if the user doesn't want to replace an existing .zshrc
		if [ $KEEP_ZSHRC = yes ]; then
			echo "${YELLOW}Found ~/.zshrc.${RESET} ${GREEN}Keeping...${RESET}"
			return
		fi
130
131
132
133
134
135
136
137
138
139
140
141
142
143
		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"
144
	fi
Robby Russell's avatar
Robby Russell committed
145

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

148
149
	sed "/^export ZSH=/ c\\
export ZSH=\"$ZSH\"
150
" "$ZSH/templates/zshrc.zsh-template" > ~/.zshrc-omztemp
151
	mv -f ~/.zshrc-omztemp ~/.zshrc
152
153

	echo
154
}
Robby Russell's avatar
Robby Russell committed
155

156
setup_shell() {
157
	# Skip setup if the user wants or stdin is closed (not running interactively).
158
	if [ $CHSH = no ]; then
159
160
161
		return
	fi

162
163
164
165
166
167
168
169
170
	# 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.
171
			${BLUE}Please manually change your default shell to zsh${RESET}
172
173
174
175
		EOF
		return
	fi

176
	echo "${BLUE}Time to change your default shell to zsh:${RESET}"
177

178
179
180
181
182
183
184
185
186
	# Prompt for user choice on changing the default login shell
	printf "${YELLOW}Do you want to change your default shell to zsh? [Y/n]${RESET} "
	read opt
	case $opt in
		y*|Y*|"") echo "Changing the shell..." ;;
		n*|N*) echo "Shell change skipped."; return ;;
		*) echo "Invalid choice. Shell change skipped."; return ;;
	esac

187
188
189
190
191
	# Check if we're running on Termux
	case "$PREFIX" in
		*com.termux*) termux=true; zsh=zsh ;;
		*) termux=false ;;
	esac
192

193
194
195
196
197
198
199
200
	if [ "$termux" != true ]; then
		# 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."
201
202
			return
		fi
203
204
205
206
207
208
209
210
211
212
213

		# 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
				error "no zsh binary found or not present in '$shells_file'"
				error "change your default shell manually."
				return
			fi
		fi
214
215
	fi

216
	# We're going to change the default shell, so back up the current one
217
	if [ -n "$SHELL" ]; then
218
219
220
221
222
		echo $SHELL > ~/.shell.pre-oh-my-zsh
	else
		grep "^$USER:" /etc/passwd | awk -F: '{print $7}' > ~/.shell.pre-oh-my-zsh
	fi

223
224
	# Actually change the default shell to zsh
	if ! chsh -s "$zsh"; then
225
		error "chsh command unsuccessful. Change your default shell manually."
226
227
228
	else
		export SHELL="$zsh"
		echo "${GREEN}Shell successfully changed to '$zsh'.${RESET}"
229
	fi
230
231

	echo
232
233
234
}

main() {
235
	# Run as unattended if stdin is closed
236
237
238
239
240
	if [ ! -t 0 ]; then
		RUNZSH=no
		CHSH=no
	fi

241
242
243
	# Parse arguments
	while [ $# -gt 0 ]; do
		case $1 in
244
			--unattended) RUNZSH=no; CHSH=no ;;
245
			--skip-chsh) CHSH=no ;;
246
			--keep-zshrc) KEEP_ZSHRC=yes ;;
247
248
249
250
		esac
		shift
	done

251
252
253
	setup_color

	if ! command_exists zsh; then
254
		echo "${YELLOW}Zsh is not installed.${RESET} Please install zsh first."
255
256
257
258
259
		exit 1
	fi

	if [ -d "$ZSH" ]; then
		cat <<-EOF
260
			${YELLOW}You already have Oh My Zsh installed.${RESET}
261
			You'll need to remove '$ZSH' if you want to reinstall.
262
263
264
265
266
267
268
		EOF
		exit 1
	fi

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

270
271
272
273
274
275
276
277
278
279
	printf "$GREEN"
	cat <<-'EOF'
		         __                                     __
		  ____  / /_     ____ ___  __  __   ____  _____/ /_
		 / __ \/ __ \   / __ `__ \/ / / /  /_  / / ___/ __ \
		/ /_/ / / / /  / / / / / / /_/ /    / /_(__  ) / / /
		\____/_/ /_/  /_/ /_/ /_/\__, /    /___/____/_/ /_/
		                        /____/                       ....is now installed!


280
281
	EOF
	cat <<-EOF
Alex Zdanowicz's avatar
Alex Zdanowicz committed
282
		Before you scream Oh My Zsh! please look over the ~/.zshrc file to select plugins, themes, and options.
283

284
285
286
		• Follow us on Twitter: $(underline https://twitter.com/ohmyzsh)
		• Join our Discord server: $(underline https://discord.gg/ohmyzsh)
		• Get stickers, shirts, coffee mugs and other swag: $(underline https://shop.planetargon.com/collections/oh-my-zsh)
287
288

	EOF
289
	printf "$RESET"
290

291
	if [ $RUNZSH = no ]; then
292
293
294
295
		echo "${YELLOW}Run zsh to try it out.${RESET}"
		exit
	fi

296
	exec zsh -l
297
298
}

299
main "$@"