🙃 A delightful community-driven (with 2,400+ contributors) framework for managing your zsh configuration. Includes 300+ optional plugins (rails, git, macOS, hub, docker, homebrew, node, php, python, etc), 140+ themes to spice up your morning, and an auto-update tool that makes it easy to keep up with the latest updates from the community.
  • Shell 98.4%
  • Python 1.5%
Find a file
Gaetan Semet 5178757f8f Merge remote-tracking branch 'bors-ltd/master'
Conflicts:
	plugins/git/git.plugin.zsh
2013-07-30 16:16:38 +02:00
completions Creating new completion scheme for buildbot and repo tools 2013-02-12 14:50:46 +01:00
custom updated bbenv 2013-07-30 16:15:08 +02:00
dot_files New aliases for git 2013-06-12 15:46:41 +02:00
lib Get number of lines changed for Git 2013-07-17 10:06:24 +02:00
log Adding a file into log/ so that we have a log file to record history to 2009-08-31 11:17:05 -07:00
plugins Merge remote-tracking branch 'bors-ltd/master' 2013-07-30 16:16:38 +02:00
templates Merge remote-tracking branch 'cadusk/master' 2013-06-13 17:13:13 +02:00
themes Merge remote-tracking branch 'ysmood/master' 2013-07-30 16:15:19 +02:00
tools git-pull add --rebase option 2013-06-25 12:08:02 +08:00
.gitignore Merge branch 'master' of https://github.com/cadusk/oh-my-zsh 2013-03-04 16:54:51 +01:00
.project Creating new completion scheme for buildbot and repo tools 2013-02-12 14:50:46 +01:00
MIT-LICENSE.txt Adding MIT-LICENSE Closes #655 2013-01-15 06:45:27 -08:00
oh-my-zsh.sh Merge pull request #1569 from ZeroKnight/master 2013-04-23 20:47:29 -07:00
README.textile update README 2013-07-17 10:06:24 +02:00

This is a Forked version of Oh-my-zsh. I maintain this fork against the following repos:

bors-ltd  https://github.com/bors-ltd/oh-my-zsh.git
cadusk  https://github.com/cadusk/oh-my-zsh.git
kipanshi  https://github.com/kipanshi/oh-my-zsh.git
upstream  https://github.com/robbyrussell/oh-my-zsh.git
ysmood  https://github.com/ysmood/oh-my-zsh.git
bchretien https://github.com/bchretien/oh-my-zsh.git

Why do I do that? I want the cuting edge zsh for my git workflow, so I select the best from every available repository (thanks github!) and I merge it with my own salt.

I also have a bunch of aliases and plugins for my own workflow : repo, pylint, python, git,...

So I can have a workflow like the following ones:

h2. Classic Git Project
# cdp
# cd myproject
# gfa # dear git, fetch me all remotes
# # hack hack hack
# gg # dear git, please show me a nice gui so I can select the lines I want to commit and enter the commit message
# # rehack
# gga # dear git, I changed my ming, let met amend my last commit
# # new hack
# gg
# gp # dear git, push these changes to my remote

h2. Git-Repo Project (Android)

# rsrra # dear repo, repo sync all project and rebase everything with auto stash.
# (hack)
# gg # dear git, commit my change
# ru # dear repo, please upload everything change to the remote

h2. Merging

# git merge <tab><tab><tab> # dear git, please merge this branch to mine
(conflict araises)
# gmt # dear git, show me what's wrong!
# # kdiff3 show me what's wrong, Ctrl+2/Ctrl+3 to choose the solution, modify the code, Ctrl+Up/Down to jump to next conflict, and then save
# gg # dear git, commit my changes
(edit the commit message)
# gp # dear git, push that to my remote

h2. Rebase / fixup / squash / reorder / split commit history

# git rewrite-history # dear git, let me edit you history up to 2 commits behind (git rebase -i HEAD~2)
# git rewrite-history4 # dear git, let me edit you history up to 4 commits behind (git rebase -i HEAD~4)
# git rewrite-history10 # dear git, let me edit you history up to 10 commits behind (git rebase -i HEAD~10)

h3. Text search

# sgrep "substring" .


h1. README

oh-my-zsh is an open source, community-driven framework for managing your ZSH configuration. It comes bundled with a ton of helpful functions, helpers, plugins, themes, and few things that make you shout...

bq. "OH MY ZSHELL!"

h2. Setup

@oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.

h3. The automatic installer... (do you trust me?)

You can install this via the command line with either `curl` or `wget`.

h4. via `curl`

@curl -L https://github.com/stibbons/oh-my-zsh/raw/master/tools/install.sh | sh@

h4. via `wget`

@wget --no-check-certificate https://github.com/stibbons/oh-my-zsh/raw/master/tools/install.sh -O - | sh@

h3. The manual way


1. Clone the repository

  @git clone git://github.com/stibbons/oh-my-zsh.git ~/.oh-my-zsh@

2. *OPTIONAL* Backup your existing ~/.zshrc file

  @cp ~/.zshrc ~/.zshrc.orig@

3. Create a new zsh config by copying the zsh template we've provided.

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


4. Set zsh as your default shell:

  @chsh -s /bin/zsh@

5. Start / restart zsh (open a new terminal is easy enough...)

h3. Problems?

You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to _Oh My Zsh_.

h2. Usage

* enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
** example: @plugins=(git osx ruby)@
* Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
** Take a look at the "current themes":https://wiki.github.com/stibbons/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
* much much more...  take a look at @lib/@ what _Oh My Zsh_ offers...

h2. Useful

the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.

h3. Customization

If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
If you have many functions which go well together you can put them as a *.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/@.

h3. Updates

By default you will be prompted to check for updates. If you would like oh-my-zsh to automatically update itself without prompting you, set the following in your ~/.zshrc

@DISABLE_UPDATE_PROMPT=true@

To disable updates entirely, put this in your ~/.zshrc

@DISABLE_AUTO_UPDATE=true@

To upgrade directly from the command line, just run @upgrade_oh_my_zsh@

h3. Uninstalling

If you want to uninstall it, just run @uninstall_oh_my_zsh@ from the command line and it'll remove itself and revert you to bash (or your previous zsh config).

h2. Help out!

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!

h3. (Don't) Send us your theme! (for now)

-I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.-

We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there.

h2. Contributors

This project wouldn't exist without all of our awesome users and contributors.

* "View our growing list of contributors":https://github.com/stibbons/oh-my-zsh/contributors

Thank you so much!