zsh

#Z shell

• my customizations on listed on the editor home page

Oh My ZSH

Upgrade

To upgrade .oh-my-zsh, run:

upgrade_oh_my_zsh

Source

Commands

| Command               | Description                                                                                                                  |  
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------- |  
| _tabs_                | Create a new tab in the current directory (macOS - requires enabling access for assistive devices under System Preferences). |  
| _take_                | Create a new directory and change to it, will create intermediate directories as required.                                   |  
| _x_ / _extract_       | Extract an archive (supported types: tar.{bz2,gz,xz,lzma}, bz2, rar, gz, tar, tbz2, tgz, zip, Z, 7z).                        |  
| _zsh_stats_           | Get a list of the top 20 commands and how many times they have been run.                                                     |  
| _uninstall_oh_my_zsh_ | Uninstall Oh-my-zsh.                                                                                                         |  
| _upgrade_oh_my_zsh_   | Upgrade Oh-my-zsh.                                                                                                           |  
| source ~/.zshrc       | Uptake new changes                                                                                                           |  

* * *

Alias	Command
alias	list all aliases
..	cd ..
...	cd ../..
....	cd ../../..
.....	cd ../../../..
/	cd /
~	cd ~
cd +n	switch to directory number n
1	cd -
2	cd +2
3	cd +3
4	cd +4
5	cd +5
6	cd +6
7	cd +7
8	cd +8
9	cd +9
md	mkdir -p
rd	rmdir
d	dirs -v (lists last used directories)

See ~/.oh-my-zsh/lib/directories.zsh

Alias

example:

alias -s rb=vim #opens ruby files in vim

$ foo.rb

vim => foo.rb

alias -g gp='| grep -i' #creates a global alias for grep

$ ps ax gp ruby

(all ruby process will be displayed)

Flag	Description
L	print each alias in the form of calls to alias
g	list or define global aliases
m	print aliases matching specified pattern
r	list or define regular aliases
s	list or define suffix aliases

Tab-completion

For options and helpful text of what they do
ls -(tab)
cap (tab)
rake (tab)
ssh (tab)
sudo umount (tab)
kill (tab)
unrar (tab)

Git

Dynamic access to current branch name with the current_branch function
git pull origin $(current_branch)
grb publish $(current_branch) origin

Alias	Command
g	git
ga	git add
gaa	git add --all
gapa	git add --patch
gb	git branch
gba	git branch -a
gbr	git branch --remote
gc	git commit -v
gc!	git commit -v --amend
gca	git commit -v -a
gca!	git commit -v -a --amend
gcl	git config --list
gclean	git clean -fd
gpristine	git reset --hard && git clean -dfx
gcm	git checkout master
gcmsg	git commit -m
gco	git checkout
gcount	git shortlog -sn
gcp	git cherry-pick
gcs	git commit -S
gd	git diff
gdca	git diff --cached
gdt	git diff-tree --no-commit-id --name-only -r
gdt	git difftool
gfa	git fetch --all --prune
gg	git gui citool
gga	git gui citool --amend
ggpnp	git pull origin $(current_branch) && git push origin $(current_branch)
ggpull	git pull origin $(current_branch)
ggl	git pull origin $(current_branch)
ggpur	git pull --rebase origin $(current_branch)
glum	git pull upstream master
ggpush	git push origin $(current_branch)
ggp	git push origin $(current_branch)
ggsup	git branch --set-upstream-to=origin/$(current_branch)
gignore	git update-index --assume-unchanged
gignored	git ls-files -v
git-svn-dcommit-push	git svn dcommit && git push github master:svntrunk
gk	gitk --all --branches
gl	git pull
glg	git log --stat --max-count = 10
glgg	git log --graph --max-count = 10
glgga	git log --graph --decorate --all
glo	git log --oneline --decorate --color
glog	git log --oneline --decorate --color --graph
glp	_git_log_prettily (git log --pretty=$1)
gm	git merge
gmt	git mergetool --no-prompt
gp	git push
gpoat	git push origin --all && git push origin --tags
gr	git remote
grba	git rebase --abort
grbc	git rebase --continue
grbs	git rebase --skip
grbi	git rebase -i
grh	git reset HEAD
grhh	git reset HEAD --hard
grmv	git remote rename
grrm	git remote remove
grset	git remote set-url
grt	cd $(git rev-parse --show-toplevel
grup	git remote update
grv	git remote -v
gsd	git svn dcommit
gsps	git show --pretty = short --show-signature
gsr	git svn rebase
gss	git status -s
gst	git status
gsta	git stash save
gstaa	git stash apply
gstd	git stash drop
gstl	git stash list
gstp	git stash pop
gsts	git stash show --text
gts	git tag -s
gunignore	git update-index --no-assume-unchanged
gunwip	git log -n 1
gup	git pull --rebase
gvt	git verify-tag
gwch	git whatchanged -p --abbrev-commit --pretty = medium
gwip	git add -A; git ls-files --deleted -z

You also find these commands in Dash as a Cheat-sheet.

Editors

Alias	Command
stt	(When using sublime plugin) Open current directory in Sublime Text 2/3
v	(When using vi-mode plugin) Edit current command line in Vim

Symfony2

Alias	Command
sf	php ./app/console
sfcl	php app/console cache:clear
sfcontainer	sf debug:container
sfcw	sf cache:warmup
sfgb	sf generate:bundle
sfroute	sf debug:router
sfsr	sf server:run -vvv

tmux

Alias	Command
ta	tmux attach -t
tad	tmux attach -d -t
ts	tmux new-session -s
tl	tmux list-sessions
tksv	tmux kill-server
tkss	tmux kill-session -t

Systemd

systemctl

Command	Description
sc-status NAME	show the status of the NAME process
sc-show NAME	show the NAME systemd .service file
sc-start NAME	start the NAME process
sc-stop NAME	stop the NAME process
sc-restart NAME	restart the NAME process
sc-enable NAME	enable the NAME process to start at boot
sc-disable NAME	disable the NAME process at boot

Prerequisites

• A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
• Zsh should be installed (v4.3.9 or more recent). If not pre-installed (run zsh --version to confirm), check the following instructions here: Installing ZSH
• curl or wget should be installed
• git should be installed (recommended v1.7.2 or higher)

Basic Installation

Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either curl or wget.

via curl

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

via wget

sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"

Manual inspection

It's a good idea to inspect the install script from projects you don't yet know. You can do that by downloading the install script first, looking through it so everything looks normal, then running it:

curl -Lo install.sh https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh
sh install.sh

Using Oh My Zsh

Plugins

Oh My Zsh comes with a shitload of plugins to take advantage of. You can take a look in the plugins directory and/or the wiki to see what's currently available.

Enabling Plugins

Once you spot a plugin (or several) that you'd like to use with Oh My Zsh, you'll need to enable them in the .zshrc file. You'll find the zshrc file in your $HOME directory. Open it with your favorite text editor and you'll see a spot to list all the plugins you want to load.

vi ~/.zshrc

For example, this might begin to look like this:

plugins=(
  git
  bundler
  dotenv
  osx
  rake
  rbenv
  ruby
)

Note that the plugins are separated by whitespace. Do not use commas between them.

Using Plugins

Most plugins (should! we're working on this) include a README, which documents how to use them.

Themes

We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have screenshots on the wiki. Check them out!

Selecting a Theme

Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just the right one (for him).

Once you find a theme that you'd like to use, you will need to edit the ~/.zshrc file. You'll see an environment variable (all caps) in there that looks like:

ZSH_THEME="robbyrussell"

To use a different theme, simply change the value to match the name of your desired theme. For example:

ZSH_THEME="agnoster" # (this is one of the fancy ones)
# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster

Note: many themes require installing the Powerline Fonts in order to render properly.

Open up a new terminal window and your prompt should look something like this:

In case you did not find a suitable theme for your needs, please have a look at the wiki for more of them.

If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.

ZSH_THEME="random" # (...please let it be pie... please be some pie..)

And if you want to pick random theme from a list of your favorite themes:

ZSH_THEME_RANDOM_CANDIDATES=(
  "robbyrussell"
  "agnoster"
)

If you only know which themes you don't like, you can add them similarly to a blacklist:

ZSH_THEME_RANDOM_BLACKLIST=(pygmalion tjkirch_mod)

FAQ

If you have some more questions or issues, you might find a solution in our FAQ.

Advanced Topics

If you're the type that likes to get their hands dirty, these sections might resonate.

Advanced Installation

Some users may want to manually install Oh My Zsh, or change the default path or other settings that the installer accepts (these settings are also documented at the top of the install script).

Custom Directory

The default location is ~/.oh-my-zsh (hidden in your home directory)

If you'd like to change the install directory with the ZSH environment variable, either by running export ZSH=/your/path before installing, or by setting it before the end of the install pipeline like this:

ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.sh

Unattended install

If you're running the Oh My Zsh install script as part of an automated install, you can pass the flag --unattended to the install.sh script. This will have the effect of not trying to change the default shell, and also won't run zsh when the installation has finished.

sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended

Installing from a forked repository

The install script also accepts these variables to allow installation of a different repository:

• REPO (default: ohmyzsh/ohmyzsh): this takes the form of owner/repository. If you set this variable, the installer will look for a repository at https://github.com/{owner}/{repository}.

• REMOTE (default: https://github.com/${REPO}.git): this is the full URL of the git repository clone. You can use this setting if you want to install from a fork that is not on GitHub (GitLab, Bitbucket...) or if you want to clone with SSH instead of HTTPS (git@github.com:user/project.git).

  NOTE: it's incompatible with setting the REPO variable. This setting will take precedence.

• BRANCH (default: master): you can use this setting if you want to change the default branch to be checked out when cloning the repository. This might be useful for testing a Pull Request, or if you want to use a branch other than master.

For example:

REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh

Manual Installation

1. Clone the repository:

git clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh

2. Optionally, backup your existing ~/.zshrc file:

cp ~/.zshrc ~/.zshrc.orig

3. Create a new zsh configuration file

You can create a new zsh config file by copying the template that we have included for you.

cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc

4. Change your default shell

chsh -s $(which zsh)

You must log out from your user session and log back in to see this change.

5. Initialize your new zsh configuration

Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.

Installation Problems

If you have any hiccups installing, here are a few common fixes.

• You might need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to oh-my-zsh.
• If you installed manually or changed the install location, check the ZSH environment variable in ~/.zshrc.

Custom Plugins and Themes

If you want to override any of the default behaviors, just add a new file (ending in .zsh) in the custom/ directory.

If you have many functions that go well together, you can put them as a XYZ.plugin.zsh file in the custom/plugins/ directory and then enable this plugin.

If you would like to override the functionality of a plugin distributed with Oh My Zsh, create a plugin of the same name in the custom/plugins/ directory and it will be loaded instead of the one in plugins/.

Getting Updates

By default, you will be prompted to check for upgrades every few weeks. If you would like oh-my-zsh to automatically upgrade itself without prompting you, set the following in your ~/.zshrc:

DISABLE_UPDATE_PROMPT=true

To disable automatic upgrades, set the following in your ~/.zshrc:

DISABLE_AUTO_UPDATE=true

Manual Updates

If you'd like to upgrade at any point in time (maybe someone just released a new plugin and you don't want to wait a week?) you just need to run:

upgrade_oh_my_zsh

Magic! 🎉

Uninstalling Oh My Zsh

Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup.

If you want to uninstall oh-my-zsh, just run uninstall_oh_my_zsh from the command-line. It will remove itself and revert your previous bash or zsh configuration.

How do I contribute to Oh My Zsh?

Before you participate in our delightful community, please read the code of conduct.

I'm far from being a Zsh expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!

We also need people to test out pull-requests. So take a look through the open issues and help where you can.

See Contributing for more details.

Do NOT send us themes

We have (more than) enough themes for the time being. Please add your theme to the external themes wiki page.

Contributors

Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome.