github-repos/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-28 07:50:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
🙃 A delightful community-driven (with 2,300+ 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 so that makes it easy to keep up with the latest updates from the community.
78 Commits 1 Branch 0 Tags 142 MiB
Shell 98.4%
Python 1.5%
19a08f15d6
Go to file
Robby Russell 19a08f15d6 not ignoring example.zsh
2009-09-23 08:05:05 -07:00
custom Moving some example files into custom/ 2009-09-23 08:02:58 -07:00
lib Moving all zsh config options into a lib/ subdirectory to make way for some upcoming changes to directory structure and configuration options 2009-09-23 07:43:36 -07: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
templates Updating install process to copy your current environments PATH and adding it to the bottom of ~/.zshrc. 2009-09-07 09:11:34 -07:00
themes Added a new theme 2009-09-22 16:09:20 -07:00
tools Updating install process to copy your current environments PATH and adding it to the bottom of ~/.zshrc. 2009-09-07 09:11:34 -07:00
.gitignore not ignoring example.zsh 2009-09-23 08:05:05 -07:00
oh-my-zsh.sh Moving some example files into custom/ 2009-09-23 08:02:58 -07:00
README.textile Updating README to instruct people to copy the .zshrc template file versus symlinking it. 2009-09-01 07:52:43 -07:00

README.textile 

A handful of functions, auto-complete helpers, and stuff that makes you shout...

bq. "OH MY ZSHELL!"

h2. Setup

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

@wget http://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@

h3. The manual way


1. Clone the repository

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

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

  *NOTE*: If you already have a ~/.zshrc file, you should back it up. @cp ~/.zshrc ~/.zshrc.orig@ in case you want to go back to your original settings.

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

3. Set zsh as your default shell:

  @chsh -s /bin/zsh@

4. 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

TODO: Update this..

* Rake autocomplete: @rake (tab)@. Will generate a cache of all your rake tasks and then let you auto-complete and/or select the task to run.
* ssh autocomplete: @ssh (tab)@ or @scp (tab)@
* Git branch, it'll tell you which branch you're in when you're in a git repository directory.
* Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
** Take a look at the "current themes":http://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with Oh My Zsh.
* much much more..

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. Thanks

* Rick Olsen (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
* Whoever created the rake autocomplete stuff, which was posted all over the internet a few years ago.

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. Send us your theme!

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