🙃 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.
Find a file
Marc Cornellà 142a6c7fd5 Fix pass zsh completion and autoloading
When autocompleting from `pass <TAB>', sometimes the following errors
appear:

  _values:compvalues:10: not enough arguments
  find: `/home/user/.password-store': No such file or directory
  _values:compvalues:10: not enough arguments
  find: `/home/user/.password-store': No such file or directory

The `_values' error happens when there is no password-store folder *or*
there are no passwords in pass; the `find' error only when there is no
password-store folder.

We can trace it back to line 108, which contains the only `_values'
statement that is executed when we autocomplete from pass. We confirm
this by following the trail of execution, which is

  _pass -> _pass_cmd_show -> _pass_complete_entries ->
        -> _pass_complete_entries_helper

If we try running the command inside `$()' on line 104, we see that it
returns nothing and the output is blank. This means that `_values' only
receives 1 of its 2 mandatory parameters, therefore the above error is
triggered (not enough arguments).

That is unless we don't have a password-store folder, in which case the
`find: [...] no such file or directory' error is *also* triggered.

We solve the first error by supplying a default value of "" if the
command outputs nothing, using the zsh construct ${var:-else}.

We solve the second error by redirecting the find command's stderr output
to /dev/null, so the error is effectively suppressed.

* * * *

This patch also fixes the first tab completion, which currently only
loads the completion function definition.

We do this by adding a `_pass' statement at the end of the file, which
runs the `_pass' completion function after loading its definition.
This is the standard way an autoloaded function works; for other examples
look at zsh's official completion files.
2014-08-29 00:39:33 +02:00
custom Move example plugin to the custom plugins dir. 2012-05-16 14:51:52 -04:00
lib Merge pull request #2828 from r3dDoX/master 2014-07-15 07:38:55 -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
plugins Fix pass zsh completion and autoloading 2014-08-29 00:39:33 +02:00
templates too many plugins = slow init warning 2014-06-04 10:53:19 +02:00
themes terminal party show exit status with color 2014-07-08 21:51:48 -07:00
tools Cancel upgrade if $ZSH is not writable 2014-06-04 19:37:14 +02:00
.gitignore Merge pull request #1117 from Peeja/move-example-plugin 2014-03-22 15:58:00 -07:00
MIT-LICENSE.txt Update license year 2014-03-12 22:37:25 -07:00
oh-my-zsh.sh Don't override ZSH_COMPDUMP if already set. 2014-06-07 10:13:21 +02:00
README.textile Update README.textile 2014-07-31 18:32:57 +05:30

!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png!

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.
If not already, install zsh using the command line first.

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 http://install.ohmyz.sh | sh@

h4. via @wget@

@wget --no-check-certificate http://install.ohmyz.sh -O - | sh@

h4. Optional: change the install directory

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

You can change the install directory with the ZSH environment variable, either
by running @export ZSH=/your/path@ before installing, or setting it before the
end of the install pipeline like this:

@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | ZSH=~/.dotfiles/zsh sh@


h3. The manual way

1. Clone the repository

  @git clone git://github.com/robbyrussell/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_.

If you installed manually or changed the install location, check ZSH in @~/.zshrc@

h2. Usage

* enable the plugins you want in your @~/.zshrc@ (take a look at the @plugins/@ directory and the "wiki":https://github.com/robbyrussell/oh-my-zsh/wiki/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 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/robbyrussell/oh-my-zsh/contributors

Thank you so much!