mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2025-12-26 02:12:33 +01:00
🙃 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.
cli
cli-app
hacktoberfest
oh-my-zsh
oh-my-zsh-plugin
oh-my-zsh-theme
ohmyzsh
plugin-framework
plugins
productivity
shell
terminal
theme
themes
zsh
zsh-configuration
4244a79148
This plugin is designed to provide a uniform prompt status that
accommodates multiple vcs systems. The intent is to have reasonable
defaults for displaying each element of work tree status but also the
flexbility to make modifications without copying and pasting entire
functions into your own theme (or reimplementing a function just to
change one aspect of its behavior).
FEATURE HIGHLIGHTS
- uniform PROMPT interface for multiple vcs types
one addition to your PROMPT gets you all
- supports git, hg, svn
- indicators and (optional) counts for the primary dirty file types of
each supported vcs (e.g. `1N 3A 2U` for 1 new, 3 added, 2 untracked)
- inspired by the `git_status_prompt` function from lib/git.zsh
- rewritten as inline awk script to:
- optionally include counts for each dirty type
- provide more readable code
- move towards more modular code to support more vcs systems
- indicators for ahead-by and behind-by with counts; commits from
upstream not yet merged or local commits not yet pushed,respectively
(git-only for now)
- dirt age indicator to show how long it has been since a
significant action in the work tree (i.e. commit, file edited)
- reworked `git_time_since_commit` function found in multiple themes
- now centralized in a plugin
- and generalized to support hg and svn
- highly configurable, with many hooks for adding style information to
each element
- can rearrange order of elements
- uses an associative array, VCS_PLUGIN, for (almost) all of its
configuration settings
- incorporates functionally equivalent replacments of all functions from
from the git, svn, and hg oh-my-zsh plugins (but not any of their
aliases)
- handles ignored subdirectories of git work trees
|
||
|---|---|---|
| custom | ||
| lib | ||
| log | ||
| plugins | ||
| templates | ||
| themes | ||
| tools | ||
| .gitignore | ||
| oh-my-zsh.sh | ||
| README.textile | ||
A handful of functions, auto-complete helpers, and stuff that makes 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?) @wget --no-check-certificate https://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 * 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/robbyrussell/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 good 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. 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. 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. h2. Contributors This project wouldn't exist without all of our awesome users and contributors. * "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors Thank you so much!