Plugins - dimensi0n/oh-my-zsh GitHub Wiki

Enable the plugins you want by editing your ~/.zshrc file.

plugins=(rails git ruby)

Completion plugins will let zsh know which arguments the package has so it can autocomplete. For instance, if you have the Homebrew plugin installed and type:

brew in

.. and then hit tab, the brew plugin will enable autocompletion to brew install. Completion plugins are not documented further on this page as they only provide better introspection for zsh into the original command. man is your friend.

You should always read the source for the plugin before using it to avoid surprises. Plugins are located in ~/.oh-my-zsh/plugins.

Below is a list of bundled plugins

• apache2-macports
• archlinux
• asdf
• aterminal
• autojump
• autopep8
• aws
• bower
• brew
• bundler
• cabal
• cake
• capistrano
• cask
• catimg
• celery
• chruby
• chucknorris
• command-not-found
• Composer
• cloudapp
• coffee
• common-aliases
• compleat
• cpanm
• debian
• dircycle
• dirhistory
• dirpersist
• django
• dnf
• docker
• encode64
• fabric
• fbterm
• Forklift
• fasd
• gas
• geeknote
• gem
• gpg-agent
• git
• gitfast
• git-extras
• git-flow
• git-flow-avh
• git-hubflow
• git_remote_branch
• github
• gradle
• grails
• httpie
• history
• jira
• jsontools
• knife
• laravel4
• last-working-dir
• lein
• lighthouse
• lol
• macports
• mercurial
• meteor
• mvn
• mysql-macports
• nanoc
• ng
• node
• npm
• nyan
• osx
• pass
• per-directory-history
• perl
• perms
• pep8
• phing
• pip
• pod
• pow
• powify
• pyenv
• pylint
• python
• rails
• rand-quote
• redis-cli
• repo
• ruby
• rvm
• sbt
• scala
• screen
• sprunge
• ssh-agent
• sublime
• sudo
• supervisor
• suse
• svn
• svn-fast-info
• symfony2
• systemd
• taskwarrior
• terminalapp
• terminitor
• textmate
• tig
• thor
• tmux
• tmuxinator
• tugboat
• urltools
• vagrant
• vi-mode
• virtualenvwrapper
• web-search
• yarn
• yii
• yii2
• yum
• zeus
• wd

Maintainer: robbyrussell

Enables aliases to control a local Apache2 installed via Macports.

Maintainer: Benjamin Boudreau

Enabled aliases for pacman (replace pac by ya for yaourt)

A plugin for the extendable version manager asdf. See the README for usage information.

Maintainer: RobLoach

Maintainer: guiferpa

This plugin show platforms version

Nodejs, NPM, Docker, Go, Python, Elixir and Ruby

1. You need to install Oh My ZSH
2. Clone plugin: git clone https://github.com/guiferpa/aterminal.git
3. Move to plugins directory: mv aterminal $HOME/.oh-my-zsh/plugins/
4. Add plugin in nano $HOME/.zshrc

Enables autojump if installed with homebrew, macports or debian/ubuntu package.

This does not add any commands on its own.

Maintainer: Gaetan Semet

Completion for the python file formatting (PEP8) tool

Maintainer: Cristian Măgherușan-Stanciu

Activates the ZSH completion plugin shipped together with the aws command-line tool

Maintainer: miklos-martin

Bower is a package manager for the web. This plugin provides some aliases and completions for this great tool.

It completes the basic commands for bower. It uses the bower help command to achieve this, not a burned-in list of commands. It also provides completion for bower install, uses the output of bower search. It takes a few seconds for the first time (in the session), but then the output of bower search is cached, so things then speed up a lot.

bi jq<TAB>

Maintainer: robbyrussell

Homebrew is an OS X package manager

This plugin:

• creates a brews alias to list installed brews (= brew list -1)
• adds completion for the brew command.

Note: With the advent of their 1.0 release, Homebrew has decided to bundle the zsh completion as part of the brew installation, so we no longer ship it with the brew plugin; now it only has brew aliases.

Maintainer: robbyrussell

Enables aliases to Bundler.

Also creates shell aliases so you don't have to type "bundle exec" before most common ruby commands when you are in a directory with a Gemfile. Here is a list of commands it does this for: annotate cap capify cucumber ey foreman guard heroku middleman nanoc rackup rainbows rails rake rspec ruby shotgun spec spork thin thor unicorn unicorn_rails

Maintainer: telser

• cabal -- auto-completion for Cabal a build tool for Haskell.

Maintainer: serby

Commands for Cake, the coffee-script build tool.

• cake -- auto complete for cake tasks

Maintainer: robbyrussell

Commands for Capistrano, a deployment tool built in Ruby.

• cap -- a few commands for Capistrano, a deployment tool built in Ruby

Maintainer: mcornella

Loads completion from non-standard locations for cask, a project management tool for Emacs.

For more information see the README.

Maintainer: posva

Original repo: catimg.git

Print pictures to the stdout using convert ImageMagick

Example usage catimg image.png options:

• -h -- print help
• -w -- select output width
• -c -- change printed character (default " " without the quotes)

Maintainer: dongweiming

Commands for celery, a distributed task queue.

celery worker<TAB>

Maintainer webframp

Loads chruby, a simple ruby version manager, if installed, and provides chruby_prompt_info variable for theme use.

Commands:

• rubies: list installed rubies or change current ruby

You can manually specify the path to load chruby from using zstyle:

• zstyle :omz:plugins:chruby path
• zstyle :omz:plugins:chruby auto

Simple build definition completion is also provided for ruby-build to make installed rubies from source faster.

Maintainers: apjanke maff

Adds Chuck Norris fortune file from http://www.k-lug.org/~kessler/projects.html. Depends on fortune (and cowsay if using chuck_cow) being installed (available via homebrew, apt, ...). Perfectly suitable as MOTD.

Last login: Fri Jan 30 23:12:26 on ttys001
 ______________________________________
( When Chuck Norris plays Monopoly, it )
( affects the actual world economy.    )
 --------------------------------------
        o   ^__^
         o  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

Maintainer: robbyrussell

Only for Ubuntu and openSUSE: If a command is not recognized in the $PATH, this will use Ubuntu's command-not-found package to find it or suggest spelling mistakes:

~$ gedit
The program 'gedit' is currently not installed. You can install it by typing:
sudo apt-get install gedit
bash: gedit: command not found

The plugin uses the command-not-found package zsh support.

Maintainer: danielcsgomes

Composer autocomplete plugin with useful aliases:

Maintainer: matthewmccullough

Uploads files and piped contents to the Cloudapp service. Outputs and copies the resultant URL to the clipboard. Uses the cloudapp ruby gem from @holman.

Maintainer: jdavis

Completion plugin for CoffeeScript.

For available options, look at the usage or run the command coffee --help.

Maintainer: Gaetan Semet

Collection of useful zsh aliases, not enabled by default since they may change some user defined aliases.

• Interactive mode for rm, cp, mv
• Completion for the python interpreter

Maintainer: robbyrussell

Completion for human beings. Further documentation needed

See this blog post about compleat

Maintainer: robbyrussell

Completion plugin for cpanminus

Maintainer: robbyrussell

A set of aliases to work with the Debian Advanced Packaging Tool, apt.

This plugin use aptitude if installed, or apt-get if not. You can just set apt_pref='apt-get' to override it.

This is a small zle trick that lets you cycle your directory stack left or right using Ctrl+Shift+Left/Right. This is useful when moving back and forth between directories in development environments, and can be thought of as kind of a nondestructive pushd/popd.

Maintainer: jeffwilliams

This plugin allows you to navigate the history of previous current-working-directories using ALT-LEFT and ALT-RIGHT. ALT-LEFT moves back to directories that the user has changed to in the past, and ALT-RIGHT undoes ALT-LEFT. MAC users may alternately use OPT-LEFT and OPT-RIGHT.

For example, if the shell was started, and the following commands were entered:

cd ~
cd /usr
cd share
cd doc

Then entering ALT-LEFT at the prompt would change directory from /usr/share/doc to /usr/share, then if pressed again to /usr/, then ~. If ALT-RIGHT were pressed the directory would be changed to /usr/ again.

Currently the max history size is 30. The navigation should work for xterm, PuTTY xterm mode, GNU screen, and on MAC with alternate keys as mentioned above.

Maintainer: robbyrussell

• dirpersist

Maintainer: robbyrussell

Adds completion for django and manage.py. See for more info.

Maintainer: robbyrussell

See the README for more information.

Maintainer: Azaan

• Auto complete arguments and options for all docker commands.
• Show containerIDs and Images for tab completion where applicable (screenshots)

Maintainer: fuksito

This is a plugin that helps to encode/decode strings with base64 from the console quickly:

$ encode64 some_string
=> c29tZV9zdHJpbmc=

$ decode64 c29tZV9zdHJpbmc=
=> some_string

Maintainer: santiycr

• fabric - completion plugin for fabric

• fbterm - automatically start fbterm when running in /dev/tty*

Maintainer: bitboxer

Maintainer: a-b

• fasd - command-line productivity booster, offers quick access to files and directories, inspired by autojump, z and v

• gas - completion plugin for the gas gem

Maintainer: Ján Koščo

See the README for more info.

Maintainer: robbyrussell

• gem - completion plugin for the gem command

Maintainer: robbyrussell

Maintainers: @Stibbons, @ncanceill

Adds a lot of git aliases and functions for pulling for dealing with the current branch. See the dedicated Wiki page, or a list of some of the aliases introduced here (OUTDATED).

Maintainer: felipec

Enables the zsh completion from git.git folks, which is much faster than the official one from zsh. A lot of zsh-specific features are not supported, like descriptions for every argument, but everything the bash completion has, this one does too (as it is using it behind the scenes). Not only is it faster, it should be more robust, and updated regularly to the latest git upstream version.

Maintainer: agrimaldi

git-extras - Support for git-extras completion

Pressing tab after the various commands should autofill authors, branches and tags depending on context.

Maintainer: robbyrussell

• git-flow - Support for git-flow completion

Maintainer:

• git-flow-avh - Support for git-flow-avh completion

Maintainer: wweaver

• git-hubflow - Support for git HubFlow completion

Maintainer: webmat

• git_remote_branch - Support for grb completion

Maintainer: robbyrussell

• github - adds autocomplete to the github gem, which is installable via gem install github

Maintainer: matthewmccullough

Adds autocompletion of task names and option switches to command line use of gradle by actually executing gradle tasks in the background and collecting the result.

Caches the result of the task names in a .gradletasknamecache file that is regenerated if the timestamp of the build.gradle file changes.

Maintainer: zachriggle

Adds tab-completion of Grails script names to the command line use of grails. Looks for scripts in the following paths:

• $GRAILS_HOME/scripts
• ~/.grails/scripts
• ./scripts
• ./plugins/*/scripts

Maintainer: lululau

Adds completion for HTTPie, which is a command line HTTP client, a user-friendly cURL replacement.

Maintainer: r-darwish

Provides a couple of convenient aliases for using the history command to examine your command line history.

Maintainer: tresni

• Open Jira issues using the command open_jira_issue

jira

jira ABC-123

If you use Rapid Board make sure to add the following to your .zshrc:

JIRA_RAPID_BOARD="true"

Maintainer: bobwilliams

handy command line tools for dealing with json data.

Maintainer: franklouwers

• knife - adds autocompletion to knife

Maintainer: m0nah

Laravel 4 autocomplete plugin!

Maintainer: op

Keeps track of the last used directory and automatically jumps to it for new shells. Similar to how many terminal emulators does it.

Maintainer: robbyrussell

• lein - auto-completion for leiningen, build tool for clojure

Maintainer: robbyrussell

• lighthouse - open lighthouse tickets using the command open_lighthouse_ticket (see http://screencast.com/t/ZDgwNDUwNT)

Maintainer: robbyrussell

• lol - brings lulz to your zsh (based on lolbash)

Maintainer: robbyrussell

• macports - adds "port" command completion and aliases for running macports commands

Maintainers: ptrv, oshybystyi

Plus it adds mercurial repo info into zsh prompt.

See detailed instructions in plugin README

Maintainer: jorge-d

This plugin adds completion for the meteor command

$ meteor [tab]
$ cd some_random_meteor_project
$ meteor add [tab] # Will list all the available packages
$ meteor remove [tab] # Will all the installed packages

Maintainer: fred-o

• mvn - adds command line completion for apache maven

Maintainer: robbyrussell

• mysql - aliases for starting stopping and getting mysql status ( mysqlstart, mysqlstop, mysqlstatus)

Maintainer: josh-

Enhances the Nanoc static site generator with aliases and ZSH autocompletion. Discussed in further detail in this blog post.

Adds completion for angular-cli (also called ng). See the README for more information.

Maintainer: @catull

Maintainer: robbyrussell

• npm - adds autocompletion to npm

Maintainer: robbyrussell

• nyan - nyan cat goodness in your shell

See the README for more information.

Maintainer: robbyrussell

Maintainer: sanbor

Completion plugin for pass. Source

Maintainer: jimhester

per-directory-history - tracks previous command history both per current directory and globally, with the ability to switch between them on the fly, bound to ctrl-g.

Maintainer: robbyrussell

• perl - useful shortcuts for perlbrew, perldoc, and perl one-liners

Maintainer: Rory Hardy

Plugin to handle some unix filesystem permissions quickly

Maintainer: Gaetan Semet

Completion for the pep8 python coding style (PEP8) check tool

Maintainer: robbyrussell

• phing - auto complete for phing targets.

Maintainer: robbyrussell

• pip - completion plugin for the pip command

Maintainer: mekanics

• Completion plugin for CocoaPods
• You can find the official documentation here

A simple powify autocomplete plugin. It includes all commands, subcomands, and rack app name autocompletion where needed.

Maintainer: ssm

• Completion for the pyenv command, which maintains local python installations.
• Exports a "pyenv_prompt_info()" function for your custom prompt.

Maintainer: Gaetan Semet

Completion for the python file coding style check tool

Maintainer: Gaetan Semet

Completion for the python interpreter

Maintainer: robbyrussell

Maintainer: posva

Creates a function quote to display a colored random quote picked from this site

Maintainer: robbyrussell

Completion plugin for redis-cli

Maintainer: Gaetan Semet

• Completion plugin for git-repo

Maintainer: robbyrussell

After rvm-update (alias for rvm get head; rvm reload), run rvm-link-completion to make a symlink to the official zsh completion file that comes with rvm into your oh-my-zsh rvm plugin directory.

Maintainer: mcaserta

• sbt - completion plugin for SBT

Maintainer: mcaserta

• scala - completion plugin for scala and scalac

Maintainer: fred-o

• screen - automatic setting of window titles and status for GNU Screen

Maintainer: ilikenwf

• sprunge - a basic cli interface to pastebin, which accepts it's input through web requests. Designed for Linux users, sprunge is an easy way to pastebin text without having to actually use a web browser. The oh-my-zsh plugin is based on http://www.shellperson.net/sprunge-pastebin-script/, author unknown.

You can use sprunge in the following ways:

echo "hello there...testing sprunge"|sprunge

sprunge test.txt

sprunge "hello"

Note that if a filename is misspelled or doesn't have the necessary path description, it will NOT generate an error, but will instead treat it as a text string and upload it.

Maintainer: robbyrussell

• ssh-agent - cygwin ssh-agent plugin for starting agent (see - http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html )

Maintainer: dylnhdsn

Maintainer: dongweiming

• ESC twice: Puts sudo in front of the current command, or the last one if the command line is empty.

Maintainer: everbird

• supervisor - Adds tab-completion for supervisord/supervisorctl in Supervisor. These scripts are from zshcompfunc4supervisor.

Maintainer: r-darwish

Maintainer: robbyrussell

• svn - adds several functions for dealing with the status of the current directory's svn repo.

• svn-fast-info - is a faster drop-in replacement of the svn plugin, it brings the same level of functionality using the same API. The speed improvements are especially visible on big SVN repository.

Maintainer: andrewtch

Symfony2 autocomplete plugin; binds to app/console, and not ./console command!

Maintainer: aelesbao

• systemd aliases plugin; Add sc-[command] aliases to all systemctl commands, using sudo when needed.

Maintainer: lepht

• taskwarrior - adds smart tab completion for TaskWarrior. For example, task[tabtab] will give you a list of current tasks, task 66[tabtab] gives a list of available modifications for that task, etc.

Maintainer: OutPunk

• terminalapp - automatically sets the Terminal.app resume directory, so when restoring windows with OS X Lion's "Resume" feature it will restore the directory too. Note: This plugin is deprecated and the functionality has been folded into core lib/termsupport.zsh which is loaded for all users. If you have a current version of Oh My Zsh, remove this from your $plugins list.

Maintainer: philippbosch

terminitor is a tool that "automates your development workflow setup".

• terminitor – auto complete for terminitor commands and scripts

Maintainer: robbyrussell

Adds aliases for tig. See the README for more information.

Completions for thor

Maintainer: jmatth

Adds several options for effecting the startup behavior of tmux. Each of the options are set by changing the environment variables below in the TOP of your ~/.zshrc file:

1. ZSH_TMUX_AUTOSTART: Automatically start a tmux session upon logging in. Set to false by default.
2. ZSH_TMUX_AUTOSTART_ONCE: Only attempt to autostart tmux once. If this is disabled when the previous option is enabled, then tmux will be autostarted every time you source your zsh config files. Set to true by default.
3. ZSH_TMUX_AUTOCONNECT: When running tmux automatically connect to the currently running tmux session if it exits, otherwise start a new session. Set to true by default.
4. ZSH_TMUX_AUTOQUIT: Close the terminal session when tmux exits. Set to the value of ZSH_TMUX_AUTOSTART by default.
5. ZSH_TMUX_FIXTERM: When running tmux, the variable $TERM is supposed to be set to screen or one of its derivatives. This option will set the default-terminal option of tmux to screen-256color if 256 color terminal support is detected, and screen otherwise. The term values it uses can be overridden by changing the ZSH_TMUX_FIXTERM_WITH_256COLOR and ZSH_TMUX_FIXTERM_WITHOUT_256COLOR variables respectively. Set to true by default.

If the user specifies any arguments for tmux then the command is just executed as it was typed it without any modification.

Completions for tmuxinator. To enable completions for mux, a shortcut for tmuxinator, add following alias in your zshrc to overwrite the executable:

Maintainer: DimitriSteyaert

• tugboat - autocompletion for Tugboat commands, the CLI tool to manage your Digital Ocean configuration and droplets.

Adds command line utilities for URL manipulation.

Maintainer: robbyrussell

• vagrant - autocompletion for Vagrant commands, task names, box names and built-in handy documentation. All in one place.

Maintainer: robbyrussell

** Read the plugin README file **

• Increase zsh vi-like functionality

Maintainer: mispy

• virtualenvwrapper - Loads Python's virtualenvwrapper shell tools, and automatically activates virtualenv on cd into git repository with matching name.

Maintainer: xuhdev

Adds several commands to do web search.

google oh-my-zsh

bing what is github

ddg foo bar

Maintainer: robbyrussell

Yarn autocompletion plugin.

Maintainer: IgorTimoshenko

Yii autocompletion plugin.

Maintainer: ekaragodin

Yii2 autocompletion plugin.

Maintainer: robbyrussell

Enables aliases for Yum, the popular front-end to the RPM Package Manager.

Homepage: Zeus project

Maintainer: Bamboo

Maintainer: johnjohndoe

Completion plugin for zeus. The describing texts are inspired by the texts given in the documentation of Rails command line tools.*Source

Maintainer: mfaerevaag

wd (warp directory) lets you jump to custom directories in zsh, without using cd. Why? Because cd seems inefficient when the folder is frequently visited or has a long path. Source

Print usage with no opts or the help argument.

wd add test

If a warp point with the same name exists, use add! to overwrite it.

wd test

wd ..
wd ...

This is a wrapper for the zsh dirs function.

wd rm test

wd show

wd list