diff --git a/plugins/apache2-macports/README.md b/plugins/apache2-macports/README.md index 099fc8da3..dbf2e89a2 100644 --- a/plugins/apache2-macports/README.md +++ b/plugins/apache2-macports/README.md @@ -1,19 +1,21 @@ -## APACHE2 MACPORTS PLUGIN +# apache2-macports plugin +Enables aliases to control a local Apache2 installed via [MacPorts](https://www.macports.org/). ---- +To use it, add `apache2-macports` to the plugins array in your zshrc file: -### FEATURES +```zsh +plugins=(... apache2-macports) +``` -| Alias | Function | Description | -|:--------------:|:-------------------------------------------------------------------------------|----------------------:| -| apache2restart | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper restart | Restart apache daemon | -| apache2start | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper start | Start apache daemon | -| apache2stop | sudo /opt/local/etc/LaunchDaemons/org.macports.apache2/apache2.wrapper stop | Stop apache daemon | +## Aliases ---- +| Alias | Function | Description | +|----------------|-----------------------------------------|-----------------------| +| apache2restart | `sudo /path/to/apache2.wrapper restart` | Restart apache daemon | +| apache2start | `sudo /path/to/apache2.wrapper start` | Start apache daemon | +| apache2stop | `sudo /path/to/apache2.wrapper stop` | Stop apache daemon | -### CONTRIBUTORS - - Alexander Rinass (alex@rinass.net) +## Contributors ---- +- Alexander Rinass (alex@rinass.net) diff --git a/plugins/archlinux/README.md b/plugins/archlinux/README.md index 9cbfe3742..5882c7603 100644 --- a/plugins/archlinux/README.md +++ b/plugins/archlinux/README.md @@ -1,5 +1,13 @@ # Archlinux plugin +This plugin adds some aliases and functions to work with Arch Linux. + +To use it, add `archlinux` to the plugins array in your zshrc file: + +```zsh +plugins=(... archlinux) +``` + ## Features #### YAY diff --git a/plugins/bower/README.md b/plugins/bower/README.md index 743b6a0ea..8877fbdc5 100644 --- a/plugins/bower/README.md +++ b/plugins/bower/README.md @@ -4,7 +4,7 @@ This plugin adds completion for [Bower](https://bower.io/) and a few useful alia To use it, add `bower` to the plugins array in your zshrc file: -``` +```zsh plugins=(... bower) ``` @@ -15,4 +15,3 @@ plugins=(... bower) | bi | `bower install` | Installs the project dependencies listed in bower.json | | bl | `bower list` | List local packages and possible updates | | bs | `bower search` | Finds all packages or a specific package. | - diff --git a/plugins/cake/README.md b/plugins/cake/README.md index aad92a3ec..2c2a28053 100644 --- a/plugins/cake/README.md +++ b/plugins/cake/README.md @@ -10,6 +10,6 @@ plugins=(... cake) ## Note -This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory. +This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory. It is regenerated when the Cakefile is newer than the cache file. It is advised that you add the cake file to your `.gitignore` files. diff --git a/plugins/catimg/README.md b/plugins/catimg/README.md index 42b59a62c..8f2688050 100644 --- a/plugins/catimg/README.md +++ b/plugins/catimg/README.md @@ -2,28 +2,16 @@ Plugin for displaying images on the terminal using the the `catimg.sh` script provided by [posva](https://github.com/posva/catimg) +To use it, add `catimg` to the plugins array in your zshrc file: + +```zsh +plugins=(... catimg) +``` + ## Requirements - `convert` (ImageMagick) -## Enabling the plugin - -1. Open your `.zshrc` file and add `catimg` in the plugins section: - - ```zsh - plugins=( - # all your enabled plugins - catimg - ) - ``` - -2. Restart the shell or restart your Terminal session: - - ```console - $ exec zsh - $ - ``` - ## Functions | Function | Description | diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md index be7b97e24..35f989180 100644 --- a/plugins/chucknorris/README.md +++ b/plugins/chucknorris/README.md @@ -1,6 +1,6 @@ # chucknorris -Chuck Norris fortunes plugin for oh-my-zsh +Chuck Norris fortunes plugin for oh-my-zsh. Perfectly suitable as MOTD. **Maintainers**: [apjanke](https://github.com/apjanke) [maff](https://github.com/maff) @@ -10,11 +10,31 @@ To use it add `chucknorris` to the plugins array in you zshrc file. plugins=(... chucknorris) ``` - -Depends on fortune (and cowsay if using chuck_cow) being installed (available via homebrew, apt, ...). Perfectly suitable as MOTD. - +## Usage | Command | Description | | ----------- | ------------------------------- | | `chuck` | Print random Chuck Norris quote | | `chuck_cow` | Print quote in cowthink | + +Example: output of `chuck_cow`: + +``` +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 | + || || +``` + +## Requirements + +- `fortune` +- `cowsay` if using `chuck_cow` + +Available via homebrew, apt, ... diff --git a/plugins/cloudapp/README.md b/plugins/cloudapp/README.md index 6c7f9bc6c..fc9fc32bd 100644 --- a/plugins/cloudapp/README.md +++ b/plugins/cloudapp/README.md @@ -4,7 +4,7 @@ To use it, add `cloudapp` to the plugins array of your `~/.zshrc` file: -``` +```zsh plugins=(... cloudapp) ``` diff --git a/plugins/coffee/README.md b/plugins/coffee/README.md index d6cd074d3..2baade844 100644 --- a/plugins/coffee/README.md +++ b/plugins/coffee/README.md @@ -1,4 +1,4 @@ -## Coffeescript Plugin +# Coffeescript Plugin This plugin provides aliases for quickly compiling and previewing your coffeescript code. diff --git a/plugins/compleat/README.md b/plugins/compleat/README.md index 630c91503..af0e383be 100644 --- a/plugins/compleat/README.md +++ b/plugins/compleat/README.md @@ -3,6 +3,7 @@ This plugin looks for [compleat](https://github.com/mbrubeck/compleat) and loads its completion. To use it, add compleat to the plugins array in your zshrc file: -``` + +```zsh plugins=(... compleat) ``` diff --git a/plugins/composer/README.md b/plugins/composer/README.md index 2b4bae579..85eef3cc7 100644 --- a/plugins/composer/README.md +++ b/plugins/composer/README.md @@ -12,18 +12,18 @@ plugins=(... composer) ## Aliases -| Alias | Command | Description | -| ------ | -------------------------------------------- | -------------------------------------------------------------------------------------- | -| `c` | composer | Starts composer | -| `csu` | composer self-update | Updates composer to the latest version | -| `cu` | composer update | Updates composer dependencies and `composer.lock` file | -| `cr` | composer require | Adds new packages to `composer.json` | -| `crm` | composer remove | Removes packages from `composer.json` | -| `ci` | composer install | Resolves and installs dependencies from `composer.json` | -| `ccp` | composer create-project | Create new project from an existing package | -| `cdu` | composer dump-autoload | Updates the autoloader | -| `cdo` | composer dump-autoload --optimize-autoloader | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) | -| `cgu` | composer global update | Allows update command to run on COMPOSER_HOME directory | -| `cgr` | composer global require | Allows require command to run on COMPOSER_HOME directory | -| `cgrm` | composer global remove | Allows remove command to run on COMPOSER_HOME directory | -| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory | +| Alias | Command | Description | +| ------ | ---------------------------------------------- | -------------------------------------------------------------------------------------- | +| `c` | `composer` | Starts composer | +| `csu` | `composer self-update` | Updates composer to the latest version | +| `cu` | `composer update` | Updates composer dependencies and `composer.lock` file | +| `cr` | `composer require` | Adds new packages to `composer.json` | +| `crm` | `composer remove` | Removes packages from `composer.json` | +| `ci` | `composer install` | Resolves and installs dependencies from `composer.json` | +| `ccp` | `composer create-project` | Create new project from an existing package | +| `cdu` | `composer dump-autoload` | Updates the autoloader | +| `cdo` | `composer dump-autoload --optimize-autoloader` | Converts PSR-0/4 autoloading to classmap for a faster autoloader (good for production) | +| `cgu` | `composer global update` | Allows update command to run on COMPOSER_HOME directory | +| `cgr` | `composer global require` | Allows require command to run on COMPOSER_HOME directory | +| `cgrm` | `composer global remove` | Allows remove command to run on COMPOSER_HOME directory | +| `cget` | `curl -s https://getcomposer.org/installer` | Installs composer in the current directory | diff --git a/plugins/copyfile/README.md b/plugins/copyfile/README.md index 53138ad06..a110b83fe 100644 --- a/plugins/copyfile/README.md +++ b/plugins/copyfile/README.md @@ -3,7 +3,8 @@ Puts the contents of a file in your system clipboard so you can paste it anywhere. To use, add `copyfile` to your plugins array: -``` + +```zsh plugins=(... copyfile) ``` diff --git a/plugins/cpanm/README.md b/plugins/cpanm/README.md index 3803e3e00..13e93d0a5 100644 --- a/plugins/cpanm/README.md +++ b/plugins/cpanm/README.md @@ -1,9 +1,9 @@ # Cpanm This plugin provides completion for [Cpanm](https://github.com/miyagawa/cpanminus) ([docs](https://metacpan.org/pod/App::cpanminus)). - + To use it add cpanm to the plugins array in your zshrc file. - - ```bash + +```zsh plugins=(... cpanm) ``` diff --git a/plugins/dirhistory/README.md b/plugins/dirhistory/README.md index 511f2be17..223650727 100644 --- a/plugins/dirhistory/README.md +++ b/plugins/dirhistory/README.md @@ -7,6 +7,7 @@ To use it, add `dirhistory` to the plugins array in your zshrc file: ```zsh plugins=(... dirhistory) ``` + ## Keyboard Shortcuts | Shortcut | Description | @@ -15,3 +16,24 @@ plugins=(... dirhistory) | alt + right | Undo alt + left | | alt + up | Move into the parent directory | | alt + down | Move into the first child directory by alphabetical order | + +## Usage + +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. + +Also, navigate directory **hierarchy** using ALT-UP and ALT-DOWN. (mac keybindings not yet implemented). ALT-UP moves to higher hierarchy (shortcut for 'cd ..'). ALT-DOWN moves into the first directory found in alphabetical order (useful to navigate long empty directories e.g. java packages) + +For example, if the shell was started, and the following commands were entered: + +```shell +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. + +After that, ALT-DOWN will probably go to /usr/bin (depends on your /usr structure), ALT-UP will return to /usr, then ALT-UP will get you to / + +**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. diff --git a/plugins/dirpersist/README.md b/plugins/dirpersist/README.md index 9880bc563..792fb4bfe 100644 --- a/plugins/dirpersist/README.md +++ b/plugins/dirpersist/README.md @@ -1,6 +1,7 @@ # Dirpersist plugin -This plugin keeps a running tally of the previous 20 unique directories in the $HOME/.zdirs file. When you cd to a new directory, it is prepended to the beginning of the file. +This plugin keeps a running tally of the previous 20 unique directories in the `$HOME/.zdirs` file. +When you cd to a new directory, it is prepended to the beginning of the file. To use it, add `dirpersist` to the plugins array in your zshrc file: diff --git a/plugins/django/README.md b/plugins/django/README.md index 415f6b7ea..1740e55e5 100644 --- a/plugins/django/README.md +++ b/plugins/django/README.md @@ -34,23 +34,3 @@ runfcgi -- run this project as a fastcgi runserver -- start a lightweight web server for development ... ``` - -If you want to see the options available for a specific command, try: - -```zsh -$> python manage.py makemessages (press here) -``` - -And that would result in: - -```zsh ---all -a -- re-examine all code and templates ---domain -d -- domain of the message files (default: "django") ---extensions -e -- file extension(s) to examine (default: ".html") ---help -- display help information ---locale -l -- locale to process (default: all) ---pythonpath -- directory to add to the Python path ---settings -- python path to settings module -... -``` - diff --git a/plugins/dnf/README.md b/plugins/dnf/README.md index f9ef496fa..dc0d1e0a0 100644 --- a/plugins/dnf/README.md +++ b/plugins/dnf/README.md @@ -1,10 +1,14 @@ -## Description +# dnf plugin -This plugin makes `dnf` usage easier by adding aliases for the most -common commands. +This plugin makes `dnf` usage easier by adding aliases for the most common commands. -`dnf` is the new package manager for RPM-based distributions, which -replaces `yum`. +`dnf` is the new package manager for RPM-based distributions, which replaces `yum`. + +To use it, add `dnf` to the plugins array in your zshrc file: + +```zsh +plugins=(... dnf) +``` ## Aliases diff --git a/plugins/docker-compose/README.md b/plugins/docker-compose/README.md index 07a87bc81..1105e03f6 100644 --- a/plugins/docker-compose/README.md +++ b/plugins/docker-compose/README.md @@ -4,7 +4,8 @@ This plugin provides completion for [docker-compose](https://docs.docker.com/com aliases for frequent docker-compose commands. To use it, add docker-compose to the plugins array of your zshrc file: -``` + +```zsh plugins=(... docker-compose) ``` diff --git a/plugins/docker/README.md b/plugins/docker/README.md index 4d9f3ae9b..241a6a448 100644 --- a/plugins/docker/README.md +++ b/plugins/docker/README.md @@ -3,6 +3,7 @@ This plugin adds auto-completion for [docker](https://www.docker.com/). To use it add `docker` to the plugins array in your zshrc file. + ```zsh plugins=(... docker) ``` diff --git a/plugins/encode64/README.md b/plugins/encode64/README.md index 66fc7cba4..a83a3d3d2 100644 --- a/plugins/encode64/README.md +++ b/plugins/encode64/README.md @@ -1,6 +1,12 @@ # encode64 -Alias plugin for encoding or decoding using `base64` command +Alias plugin for encoding or decoding using `base64` command. + +To use it, add `encode64` to the plugins array in your zshrc file: + +```zsh +plugins=(... encode64) +``` ## Functions and Aliases @@ -9,23 +15,6 @@ Alias plugin for encoding or decoding using `base64` command | `encode64` | `e64` | Encodes given data to base64 | | `decode64` | `d64` | Decodes given data from base64 | -## Enabling plugin - -1. Edit your `.zshrc` file and add `encode64` to the list of plugins: - - ```sh - plugins=( - # ...other enabled plugins - encode64 - ) - ``` - -2. Restart your terminal session or restart the shell: - - ```sh - exec zsh - ``` - ## Usage and examples ### Encoding diff --git a/plugins/fabric/README.md b/plugins/fabric/README.md index cf0fa81f4..f121d2ed8 100644 --- a/plugins/fabric/README.md +++ b/plugins/fabric/README.md @@ -4,6 +4,6 @@ This plugin provides completion for [Fabric](https://www.fabfile.org/). To use it add fabric to the plugins array in your zshrc file. -```bash +```zsh plugins=(... fabric) ``` diff --git a/plugins/fasd/fasd.plugin.zsh b/plugins/fasd/fasd.plugin.zsh index cdf99708c..6538d097e 100644 --- a/plugins/fasd/fasd.plugin.zsh +++ b/plugins/fasd/fasd.plugin.zsh @@ -1,13 +1,16 @@ -if [ $commands[fasd] ]; then # check if fasd is installed - fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache" - if [ "$(command -v fasd)" -nt "$fasd_cache" -o ! -s "$fasd_cache" ]; then - fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \ - zsh-wcomp zsh-wcomp-install >| "$fasd_cache" - fi - source "$fasd_cache" - unset fasd_cache - - alias v='f -e "$EDITOR"' - alias o='a -e xdg-open' - alias j='zz' +# check if fasd is installed +if (( ! ${+commands[fasd]} )); then + return fi + +fasd_cache="${ZSH_CACHE_DIR}/fasd-init-cache" +if [[ "$commands[fasd]" -nt "$fasd_cache" || ! -s "$fasd_cache" ]]; then + fasd --init posix-alias zsh-hook zsh-ccomp zsh-ccomp-install \ + zsh-wcomp zsh-wcomp-install >| "$fasd_cache" +fi +source "$fasd_cache" +unset fasd_cache + +alias v='f -e "$EDITOR"' +alias o='a -e xdg-open' +alias j='zz' diff --git a/plugins/fbterm/README.md b/plugins/fbterm/README.md index eec33d7ee..70ce56da8 100644 --- a/plugins/fbterm/README.md +++ b/plugins/fbterm/README.md @@ -3,7 +3,8 @@ This plugin automatically starts [fbterm](https://github.com/zhangyuanwei/fbterm) if on a real TTY (`/dev/tty*`). -To use it, add fbterm to the plugins array of your zshrc file: -``` +To use it, add `fbterm` to the plugins array of your zshrc file: + +```zsh plugins=(... fbterm) ``` diff --git a/plugins/forklift/README.md b/plugins/forklift/README.md index 6c4ce1e81..7dfd8bf95 100644 --- a/plugins/forklift/README.md +++ b/plugins/forklift/README.md @@ -1,15 +1,23 @@ -## forklift +# forklift Plugin for ForkLift, an FTP application for OS X. -### Requirements +To use it, add `forklift` to the plugins array in your zshrc file: + +```zsh +plugins=(... forklift) +``` + +## Requirements * [ForkLift](https://binarynights.com/) -### Usage +## Usage -fl [*file_or_folder*] +`fl []` * If `fl` is called without arguments then the current folder is opened in ForkLift. This is equivalent to `fl .`. -* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift. If called with a non-directory file as the argument, then the file's parent directory is opened. +* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift + +* If `fl` is called with a non-directory file as the argument, then the file's parent directory is opened. diff --git a/plugins/gas/README.md b/plugins/gas/README.md index cd8800e7d..47b3fb9df 100644 --- a/plugins/gas/README.md +++ b/plugins/gas/README.md @@ -4,6 +4,7 @@ This plugin adds autocompletion for the [gas](http://walle.github.com/gas) comma a utility to manage Git authors. To use it, add `gas` to the plugins array of your zshrc file: + ```zsh plugins=(... gas) ``` diff --git a/plugins/geeknote/README.md b/plugins/geeknote/README.md index 99c1fbf5b..95b3aa7dd 100644 --- a/plugins/geeknote/README.md +++ b/plugins/geeknote/README.md @@ -1,19 +1,10 @@ -ZSH-Geeknote -============ +# Geeknote plugin -[Geeknote](https://github.com/VitaliyRodnenko/geeknote) plugin for oh-my-zsh. +This plugin provides autocompletion for [Geeknote](https://github.com/VitaliyRodnenko/geeknote) +and an alias for `geeknote` called `gn`. -Plugins provides: +To use it, add `geeknote` to the plugins array in your zshrc file: -* auto completion of commands and their options -* alias `gn` - -## Installation - -### oh-my-zsh -This plugin is already bundled in oh-my-zsh. To enable just configure plugin definition - - plugins=( ... geeknote ...) - -### Antigen -Use [Antigen's](https://github.com/zsh-users/antigen) bundle command to install by adding `antigen bundle s7anley/zsh-geeknote` to your `.zshrc` along with your other plugins. +```zsh +plugins=( ... geeknote ...) +``` diff --git a/plugins/git-extras/README.md b/plugins/git-extras/README.md index 987f0d800..2adc9d477 100644 --- a/plugins/git-extras/README.md +++ b/plugins/git-extras/README.md @@ -2,10 +2,16 @@ This plugin provides completion definitions for some of the commands defined by [git-extras](https://github.com/tj/git-extras). -## Setup notes +To use it, add `git-extras` to the plugins array in your zshrc file: + +```zsh +plugins=(... git-extras) +``` + +## Setup notes The completions work by augmenting the `_git` completion provided by `zsh`. This only works with the `zsh`-provided `_git`, not the `_git` provided by `git` itself. If you have both `zsh` and `git` installed, you need to make sure that the `zsh`-provided `_git` takes precedence. ### OS X Homebrew Setup -On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands. +**NOTE:** this no longer works on current Homebrew distributions of git. ~~On OS X with Homebrew, you need to install `git` with `brew install git --without-completions`. Otherwise, `git`'s `_git` will take precedence, and you won't see the completions for `git-extras` commands.~~ diff --git a/plugins/git-flow/README.md b/plugins/git-flow/README.md index 5d8049e3b..9c25dec83 100644 --- a/plugins/git-flow/README.md +++ b/plugins/git-flow/README.md @@ -1,18 +1,15 @@ # Git-Flow plugin -This plugin adds completion and aliases for the `git-flow` command. More information -at https://github.com/nvie/gitflow. +This plugin adds completion and aliases for the [`git-flow` command](https://github.com/nvie/gitflow). -Enable git-flow plugin in your zshrc file: -``` +To use it, add `git-flow` to the plugins array in your zshrc file: + +```zsh plugins=(... git-flow) ``` ## Aliases -More information about `git-flow` commands: -https://github.com/nvie/gitflow/wiki/Command-Line-Arguments - | Alias | Command | Description | |---------|----------------------------|----------------------------------------| | `gfl` | `git flow` | Git-Flow command | @@ -30,3 +27,5 @@ https://github.com/nvie/gitflow/wiki/Command-Line-Arguments | `gflfp` | `git flow feature publish` | Publish feature: `gflfp ` | | `gflhf` | `git flow hotfix finish` | Finish hotfix: `gflhf ` | | `gflrf` | `git flow release finish` | Finish release: `gflrf ` | + +[More information about `git-flow` commands](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments). diff --git a/plugins/git-remote-branch/README.md b/plugins/git-remote-branch/README.md index bd73e5dec..d4eb75954 100644 --- a/plugins/git-remote-branch/README.md +++ b/plugins/git-remote-branch/README.md @@ -3,8 +3,9 @@ This plugin adds completion for [`grb`](https://github.com/webmat/git_remote_branch), or `git_remote_branch`. -To use it, add `git-remote-branch` to the plugins array of your `.zshrc` file: -``` +To use it, add `git-remote-branch` to the plugins array of your zshrc file: + +```zsh plugins=(... git-remote-branch) ``` diff --git a/plugins/git/README.md b/plugins/git/README.md index 4799b1cdd..64a3b2209 100644 --- a/plugins/git/README.md +++ b/plugins/git/README.md @@ -172,7 +172,7 @@ plugins=(... git) | gwch | git whatchanged -p --abbrev-commit --pretty=medium | | gwip | git add -A; git rm $(git ls-files --deleted) 2> /dev/null; git commit --no-verify --no-gpg-sign -m "--wip-- [skip ci]" | -### Deprecated +### Deprecated aliases These are aliases that have been removed, renamed, or otherwise modified in a way that may, or may not, receive further support. @@ -211,7 +211,7 @@ These features allow to pause a branch development and switch to another one (_" | gwip | Commit wip branch | | gunwip | Uncommit wip branch | -### Deprecated +### Deprecated functions | Command | Description | Reason | |:-----------------------|:----------------------------------------|:----------------------------------------------------------------| diff --git a/plugins/gitfast/README.md b/plugins/gitfast/README.md index 23db5393b..fed4b120a 100644 --- a/plugins/gitfast/README.md +++ b/plugins/gitfast/README.md @@ -1,6 +1,6 @@ # Gitfast plugin -This plugin adds completion for Git, using 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.. +This plugin adds completion for Git, using 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. To use it, add `gitfast` to the plugins array in your zshrc file: diff --git a/plugins/github/README.md b/plugins/github/README.md index 2b66e390f..70b863f64 100644 --- a/plugins/github/README.md +++ b/plugins/github/README.md @@ -1,4 +1,4 @@ -# github +# github plugin This plugin supports working with GitHub from the command line. It provides a few things: @@ -6,7 +6,7 @@ This plugin supports working with GitHub from the command line. It provides a fe * Completion for the `github` Ruby gem. * Convenience functions for working with repos and URLs. -### Functions +### Functions * `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub * `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub @@ -14,13 +14,13 @@ This plugin supports working with GitHub from the command line. It provides a fe * `git.io` - Shortens a URL using [git.io](https://git.io) -## Installation +## Installation [Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ. The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it. -### Configuration +### Configuration These settings affect `github`'s behavior. @@ -35,7 +35,7 @@ These settings affect `github`'s behavior. See `man hub` for more details. -### Homebrew installation note +### Homebrew installation note If you have installed `hub` using Homebrew, its completions may not be on your `$FPATH` if you are using the system `zsh`. Homebrew installs `zsh` completion definitions to `/usr/local/share/zsh/site-functions`, which will be on `$FPATH` for the Homebrew-installed `zsh`, but not for the system `zsh`. If you want it to work with the system `zsh`, add this to your `~/.zshrc` before it sources `oh-my-zsh.sh`. diff --git a/plugins/gpg-agent/README.md b/plugins/gpg-agent/README.md index a9711f923..9c1e6d2cc 100644 --- a/plugins/gpg-agent/README.md +++ b/plugins/gpg-agent/README.md @@ -3,6 +3,7 @@ Enables [GPG's gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/) if it is not running. To use it, add gpg-agent to the plugins array of your zshrc file: -``` + +```zsh plugins=(... gpg-agent) ``` diff --git a/plugins/gradle/README.md b/plugins/gradle/README.md index a94ac3d0d..3756db0dc 100644 --- a/plugins/gradle/README.md +++ b/plugins/gradle/README.md @@ -18,6 +18,7 @@ whether it is `gradle` or `gradlew`. It also supports being called from any directory inside the root project directory. Examples: + ```zsh gradle test gradle build diff --git a/plugins/grails/README.md b/plugins/grails/README.md index 64b4a9f07..5d9ebd77d 100644 --- a/plugins/grails/README.md +++ b/plugins/grails/README.md @@ -14,58 +14,3 @@ It looks for scripts in the following paths: - `~/.grails/scripts` - `./scripts` - `./plugins/*/scripts` - -## Grails Commands -- `add-proxy` -- `alias` -- `bootstrap` -- `bug-report` -- `clean` -- `clean-all` -- `clear-proxy` -- `compile` -- `console` -- `create-app` -- `create-controller` -- `create-domain-class` -- `create-filters` -- `create-integration-test` -- `create-multi-project-build` -- `create-plugin` -- `create-pom` -- `create-script` -- `create-service` -- `create-tag-lib` -- `create-unit-test` -- `dependency-report` -- `doc` -- `help` -- `init` -- `install-app-templates` -- `install-dependency` -- `install-plugin` -- `install-templates` -- `integrate-with` -- `interactive` -- `list-plugin-updates` -- `list-plugins` -- `migrate-docs` -- `package` -- `package-plugin` -- `plugin-info` -- `refresh-dependencies` -- `remove-proxy` -- `run-app` -- `run-script` -- `run-war` -- `set-grails-version` -- `set-proxy` -- `set-version` -- `shell` -- `stats` -- `stop-app` -- `test-app` -- `uninstall-plugin` -- `url-mappings-report` -- `war` -- `wrapper` diff --git a/plugins/history/README.md b/plugins/history/README.md index dd9286894..a9d480f46 100644 --- a/plugins/history/README.md +++ b/plugins/history/README.md @@ -1,15 +1,17 @@ -## history +# history plugin Provides a couple of convenient aliases for using the `history` command to examine your command line history. -### Requirements +To use it, add `history` to the plugins array in your zshrc file: -* None. +```zsh +plugins=(... history) +``` -### Usage +## Aliases -* If `h` is called, your command history is listed. Equivalent to using `history` - -* If `hsi` is called with an argument, a **case insensitive** `grep` search is performed on your command history, looking for commands that match the argument provided - -* If `hsi` is called without an argument you will help on `grep` arguments \ No newline at end of file +| Alias | Command | Description | +|-------|----------------------|------------------------------------------------------------------| +| `h` | `history` | Prints your command history | +| `hs` | `history \| grep` | Use grep to search your command history | +| `hsi` | `history \| grep -i` | Use grep to do a case-insensitive search of your command history | diff --git a/plugins/history/history.plugin.zsh b/plugins/history/history.plugin.zsh index 0f4aa4b10..9cee48fe4 100644 --- a/plugins/history/history.plugin.zsh +++ b/plugins/history/history.plugin.zsh @@ -1,8 +1,3 @@ alias h='history' - -function hs -{ - history | grep $* -} - -alias hsi='hs -i' +alias hs='history | grep' +alias hsi='history | grep -i' diff --git a/plugins/httpie/README.md b/plugins/httpie/README.md index f22d3a64e..25bdd0c7d 100644 --- a/plugins/httpie/README.md +++ b/plugins/httpie/README.md @@ -11,5 +11,4 @@ plugins=(... httpie) It uses completion from [zsh-completions](https://github.com/zsh-users/zsh-completions). - **Maintainer:** [lululau](https://github.com/lululau) diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md index 4faf58b98..2a5a76139 100644 --- a/plugins/jsontools/README.md +++ b/plugins/jsontools/README.md @@ -2,41 +2,47 @@ Handy command line tools for dealing with json data. -## Tools +To use it, add `jsontools` to the plugins array in your zshrc file: -- **pp_json** - pretty prints json -- **is_json** - returns true if valid json; false otherwise -- **urlencode_json** - returns a url encoded string for the given json -- **urldecode_json** - returns decoded json for the given url encoded string +```zsh +plugins=(... jsontools) +``` ## Usage -Usage is simple...just take your json data and pipe it into the appropriate jsontool. -```sh - | -``` -## Examples -##### pp_json +Usage is simple... just take your json data and pipe it into the appropriate jsontool: + +- `pp_json`: pretty prints json. +- `is_json`: returns true if valid json; false otherwise. +- `urlencode_json`: returns a url encoded string for the given json. +- `urldecode_json`: returns decoded json for the given url encoded string. + +### Examples + +- **pp_json**: ```sh # curl json data and pretty print the results curl https://coderwall.com/bobwilliams.json | pp_json ``` -##### is_json +- **is_json**: + ```sh # pretty print the contents of an existing json file less data.json | is_json ``` -##### urlencode_json +- **urlencode_json**: + ```sh # json data directly from the command line echo '{"b":2, "a":1}' | urlencode_json ``` -##### urldecode_json +- **urldecode_json**: + ```sh # url encoded string to decode echo '%7B%22b%22:2,%20%22a%22:1%7D%0A' | urldecode_json -``` \ No newline at end of file +``` diff --git a/plugins/laravel4/README.md b/plugins/laravel4/README.md index c945601f7..97a6a7899 100644 --- a/plugins/laravel4/README.md +++ b/plugins/laravel4/README.md @@ -10,9 +10,9 @@ plugins=(... laravel4) ## Aliases -| Alias | Command | Description | -|-----------|-------------------------------------------|-------------------------------------------------------------| -| la4 | `php artisan` | Main Artisan command | -| la4dump | `php artisan dump-autoload` | Regenerate framework autoload files | -| la4cache | `php artisan cache:clear` | Flush the application cache | -| la4routes | `php artisan routes` | List all registered routes | +| Alias | Command | Description | +|-----------|-----------------------------|-------------------------------------| +| la4 | `php artisan` | Main Artisan command | +| la4dump | `php artisan dump-autoload` | Regenerate framework autoload files | +| la4cache | `php artisan cache:clear` | Flush the application cache | +| la4routes | `php artisan routes` | List all registered routes | diff --git a/plugins/last-working-dir/README.md b/plugins/last-working-dir/README.md index 4cc4acab6..ced9e0370 100644 --- a/plugins/last-working-dir/README.md +++ b/plugins/last-working-dir/README.md @@ -6,4 +6,10 @@ for new shells, unless: - The plugin is already loaded. - The current `$PWD` is not `$HOME`. -Adds `lwd` function to jump to the last working directory. +Also adds `lwd` function to jump to the last working directory. + +To use it, add `last-working-dir` to the plugins array in your zshrc file: + +```zsh +plugins=(... last-working-dir) +``` diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md index 0db29b4e5..55587b20e 100644 --- a/plugins/lighthouse/README.md +++ b/plugins/lighthouse/README.md @@ -16,7 +16,8 @@ plugins=(... lighthouse) file in your directory with the URL to the individual project. Example: - ```zsh + + ```console $ cat .lighthouse-url https://rails.lighthouseapp.com/projects/8994 @@ -24,3 +25,5 @@ plugins=(... lighthouse) Opening ticket #23 # The browser goes to https://rails.lighthouseapp.com/projects/8994/tickets/23 ``` + +See a demo: http://screencast.com/t/ZDgwNDUwNT diff --git a/plugins/lol/README.md b/plugins/lol/README.md index 1791de493..ea6b0c3b8 100644 --- a/plugins/lol/README.md +++ b/plugins/lol/README.md @@ -1,67 +1,55 @@ # lol -Plugin for adding catspeak aliases, because why not +Plugin for adding catspeak aliases, because why not. -## Enabling the plugin +To use it, add `lol` to the plugins array in your zshrc file: -1. Open your `.zshrc` file and add `lol` in the plugins section: - - ```zsh - plugins=( - # all your enabled plugins - lol - ) - ``` - -2. Restart your terminal session or restart the shell: - - ```console - $ exec zsh - $ - ``` +```zsh +plugins=(... lol) +``` ## Aliases -| Alias | Command | -| ------------ | ---------------------------------------------------------------- | -| `:3` | `echo` | -| `alwayz` | `tail -f` | -| `bringz` | `git pull` | -| `btw` | `nice` | -| `byes` | `exit` | -| `chicken` | `git add` | -| `cya` | `reboot` | -| `donotwant` | `rm` | -| `dowant` | `cp` | -| `gimmeh` | `touch` | -| `gtfo` | `mv` | -| `hackzor` | `git init` | -| `hai` | `cd` | -| `icanhas` | `mkdir` | -| `ihasbucket` | `df -h` | -| `iminurbase` | `finger` | -| `inur` | `locate` | -| `invisible` | `cat` | -| `iz` | `ls` | -| `kthxbai` | `halt` | -| `letcat` | `git checkout` | -| `moar` | `more` | -| `nomnom` | `killall` | -| `nomz` | `ps aux` | -| `nowai` | `chmod` | -| `oanward` | `git commit -m` | -| `obtw` | `nohup` | -| `onoz` | `cat /var/log/errors.log` | -| `ooanward` | `git commit -am` | -| `plz` | `pwd` | -| `pwned` | `ssh` | -| `rtfm` | `man` | -| `rulz` | `git push` | -| `tldr` | `less` | -| `violenz` | `git rebase` | -| `visible` | `echo` | -| `wtf` | `dmesg` | -| `yolo` | `git commit -m "$(curl -s http://whatthecommit.com/index.txt)"` | +| Alias | Command | +| ------------ | --------------------------------------------------------------- | +| `:3` | `echo` | +| `alwayz` | `tail -f` | +| `bringz` | `git pull` | +| `btw` | `nice` | +| `byes` | `exit` | +| `chicken` | `git add` | +| `cya` | `reboot` | +| `donotwant` | `rm` | +| `dowant` | `cp` | +| `gimmeh` | `touch` | +| `gtfo` | `mv` | +| `hackzor` | `git init` | +| `hai` | `cd` | +| `icanhas` | `mkdir` | +| `ihasbucket` | `df -h` | +| `iminurbase` | `finger` | +| `inur` | `locate` | +| `invisible` | `cat` | +| `iz` | `ls` | +| `kthxbai` | `halt` | +| `letcat` | `git checkout` | +| `moar` | `more` | +| `nomnom` | `killall` | +| `nomz` | `ps aux` | +| `nowai` | `chmod` | +| `oanward` | `git commit -m` | +| `obtw` | `nohup` | +| `onoz` | `cat /var/log/errors.log` | +| `ooanward` | `git commit -am` | +| `plz` | `pwd` | +| `pwned` | `ssh` | +| `rtfm` | `man` | +| `rulz` | `git push` | +| `tldr` | `less` | +| `violenz` | `git rebase` | +| `visible` | `echo` | +| `wtf` | `dmesg` | +| `yolo` | `git commit -m "$(curl -s http://whatthecommit.com/index.txt)"` | ## Usage Examples diff --git a/plugins/mercurial/README.md b/plugins/mercurial/README.md index 68c7d0f43..80ea2de31 100644 --- a/plugins/mercurial/README.md +++ b/plugins/mercurial/README.md @@ -1,61 +1,66 @@ # Mercurial plugin -### Usage -Update .zshrc: -1. Add name to the list of plugins, e.g. `plugins=(... mercurial ...)` - (that is pretty obvious). -2. Switch to a theme which uses `hg_prompt_info`. +This plugin adds some handy aliases for using Mercurial as well as a few +utility and prompt functions that can be used in a theme. - Or, customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info. This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in `.zshrc` after loading the theme. +To use it, add `mercurial` to the plugins array in your zshrc file: - The `robbyrussell` theme is used by default, so you need to modify `$PROMPT` var by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so it looks like this: +```zsh +plugins=(... mercurial) +``` - ```zsh - PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}' - ``` +## Aliases -3. Initialize additional vars used in plugin. So in short put next in **.zshrc**: +| Alias | Command | +|--------|-------------------------------------------------------------------------------------------------------------| +| `hga` | `hg add` | +| `hgc` | `hg commit` | +| `hgca` | `hg commit --amend` | +| `hgb` | `hg branch` | +| `hgba` | `hg branches` | +| `hgbk` | `hg bookmarks` | +| `hgco` | `hg checkout` | +| `hgd` | `hg diff` | +| `hged` | `hg diffmerge` | +| `hgp` | `hg push` | +| `hgs` | `hg status` | +| `hgsl` | `hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"` | +| `hgun` | `hg resolve --list` | +| `hgi` | `hg incoming` | +| `hgl` | `hg pull -u` | +| `hglr` | `hg pull --rebase` | +| `hgo` | `hg outgoing` | - ``` - ZSH_THEME_HG_PROMPT_PREFIX="%{$fg_bold[magenta]%}hg:(%{$fg[red]%}" - ZSH_THEME_HG_PROMPT_SUFFIX="%{$reset_color%}" - ZSH_THEME_HG_PROMPT_DIRTY="%{$fg[magenta]%}) %{$fg[yellow]%}✗%{$reset_color%}" - ZSH_THEME_HG_PROMPT_CLEAN="%{$fg[magenta]%})" - ``` +## Prompt usage -### What's inside? -#### Adds handy aliases: -###### general -* `hga` - 'hg add` -* `hgc` - `hg commit` -* `hgb` - `hg branch` -* `hgba` - `hg branches` -* `hgbk` - `hg bookmarks` -* `hgco` - `hg checkout` -* `hgd` - `hg diff` -* `hged` - `hg diffmerge` +- Switch to a theme which uses `hg_prompt_info` -###### pull and update -* `hgi` - `hg incoming` -* `hgl` - `hg pull -u` -* `hglr` - `hg pull --rebase` -* `hgo` - `hg outgoing` -* `hgp` - `hg push` -* `hgs` - `hg status` -* `hgsl` - `hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"` +- Or customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info. + This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in + `.zshrc` after loading the theme. -###### this is the 'git commit --amend' equivalent -* `hgca` - `hg qimport -r tip ; hg qrefresh -e ; hg qfinish tip` + For example, for the `robbyrussell` theme you need to modify `$PROMPT` var by adding `$(hg_prompt_info)` + after `$(git_prompt_info)`, so it looks like this: -###### list unresolved files (since hg does not list unmerged files in the status command) -* `hgun` - `hg resolve --list` + ```zsh + PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}' + ``` -#### Displays repo branch and directory status in prompt -This is the same as git plugin does. +You can also redefine additional vars used in the plugin (after Oh My Zsh is sourced): -**Note**: Additional changes to **.zshrc**, or using a theme designed to use `hg_prompt_info`, are required in order for this to work. +```zsh +ZSH_THEME_HG_PROMPT_PREFIX="%{$fg_bold[magenta]%}hg:(%{$fg[red]%}" +ZSH_THEME_HG_PROMPT_SUFFIX="%{$reset_color%}" +ZSH_THEME_HG_PROMPT_DIRTY="%{$fg[magenta]%}) %{$fg[yellow]%}✗%{$reset_color%}" +ZSH_THEME_HG_PROMPT_CLEAN="%{$fg[magenta]%})" +``` -### Mantainers -[ptrv](https://github.com/ptrv) - original creator +### Display repo branch and directory status in prompt -[oshybystyi](https://github.com/oshybystyi) - created this README and know how most of code works +This is the same as git plugin does. **Note**: additional changes to `.zshrc`, or using a theme designed +to use `hg_prompt_info`, are required in order for this to work. + +## Mantainers + +- [ptrv](https://github.com/ptrv): original creator +- [oshybystyi](https://github.com/oshybystyi) diff --git a/plugins/mercurial/mercurial.plugin.zsh b/plugins/mercurial/mercurial.plugin.zsh index 58bc571a0..f13430476 100644 --- a/plugins/mercurial/mercurial.plugin.zsh +++ b/plugins/mercurial/mercurial.plugin.zsh @@ -1,23 +1,22 @@ -# Mercurial +# aliases alias hga='hg add' alias hgc='hg commit' +alias hgca='hg commit --amend' alias hgb='hg branch' alias hgba='hg branches' alias hgbk='hg bookmarks' alias hgco='hg checkout' alias hgd='hg diff' alias hged='hg diffmerge' +alias hgp='hg push' +alias hgs='hg status' +alias hgsl='hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n"' +alias hgun='hg resolve --list' # pull and update alias hgi='hg incoming' alias hgl='hg pull -u' alias hglr='hg pull --rebase' alias hgo='hg outgoing' -alias hgp='hg push' -alias hgs='hg status' -alias hgsl='hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}\n" ' -alias hgca='hg commit --amend' -# list unresolved files (since hg does not list unmerged files in the status command) -alias hgun='hg resolve --list' function in_hg() { if [[ -d .hg ]] || $(hg summary > /dev/null 2>&1); then diff --git a/plugins/meteor/README.md b/plugins/meteor/README.md index 187a45a62..f7c43b7bd 100644 --- a/plugins/meteor/README.md +++ b/plugins/meteor/README.md @@ -1,9 +1,10 @@ -## Introduction +# meteor plugin The [meteor plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/meteor) provides many [useful aliases](#aliases) as well as completion for the `meteor` command. Enable it by adding `meteor` to the plugins array in your zshrc file: + ```zsh plugins=(... meteor) ``` diff --git a/plugins/mvn/README.md b/plugins/mvn/README.md index 3bbba5b4f..72cea9cb9 100644 --- a/plugins/mvn/README.md +++ b/plugins/mvn/README.md @@ -4,6 +4,7 @@ The mvn plugin provides many [useful aliases](#aliases) as well as completion fo the [Apache Maven](https://maven.apache.org/) command (`mvn`). Enable it by adding `mvn` to the plugins array in your zshrc file: + ```zsh plugins=(... mvn) ``` diff --git a/plugins/mysql-macports/README.md b/plugins/mysql-macports/README.md index a4224d9c0..ff4fb3a34 100644 --- a/plugins/mysql-macports/README.md +++ b/plugins/mysql-macports/README.md @@ -12,9 +12,9 @@ For instructions on how to install MySQL using MacPorts, read the [MacPorts wiki ## Aliases -| Alias | Command | Description | -| ------------ | --------------------------------------------------------- | ------------------------------------------ | -| mysqlstart | `sudo /opt/local/share/mysql5/mysql/mysql.server start` | Start the MySQL server. | -| mysqlstop | `sudo /opt/local/share/mysql5/mysql/mysql.server stop` | Stop the MySQL server. | -| mysqlrestart | `sudo /opt/local/share/mysql5/mysql/mysql.server restart` | Restart the MySQL server. | -| mysqlstatus | `mysqladmin5 -u root -p ping` | Check whether the MySQL server is running. | +| Alias | Command | Description | +| ------------ | ------------------------------------ | ------------------------------------------ | +| mysqlstart | `sudo /path/to/mysql.server start` | Start the MySQL server. | +| mysqlstop | `sudo /path/to/mysql.server stop` | Stop the MySQL server. | +| mysqlrestart | `sudo /path/to/mysql.server restart` | Restart the MySQL server. | +| mysqlstatus | `mysqladmin5 -u root -p ping` | Check whether the MySQL server is running. | diff --git a/plugins/node/README.md b/plugins/node/README.md index c392dc0bf..911b6693b 100644 --- a/plugins/node/README.md +++ b/plugins/node/README.md @@ -1,16 +1,19 @@ # node plugin +This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org) +documentation (depending on the installed version). + To use it, add `node` to the plugins array of your zshrc file: + ```zsh plugins=(... node) ``` -This plugin adds `node-docs` function that open specific section in [Node.js](https://nodejs.org) documentation (depending on the installed version). -For example: +## Usage ```zsh # Opens https://nodejs.org/docs/latest-v10.x/api/fs.html $ node-docs fs # Opens https://nodejs.org/docs/latest-v10.x/api/path.html -$ node-docs path +$ node-docs path ``` diff --git a/plugins/npm/README.md b/plugins/npm/README.md index 202e2b0a4..0b1a2280f 100644 --- a/plugins/npm/README.md +++ b/plugins/npm/README.md @@ -1,9 +1,10 @@ -## npm plugin +# npm plugin The npm plugin provides completion as well as adding many useful aliases. To use it, add npm to the plugins array of your zshrc file: -``` + +```zsh plugins=(... npm) ``` diff --git a/plugins/osx/README.md b/plugins/osx/README.md index f3881ec6b..50e9e7f21 100644 --- a/plugins/osx/README.md +++ b/plugins/osx/README.md @@ -1,8 +1,6 @@ # OSX plugin -## Description - -This plugin provides a few utilities to make it more enjoyable on OSX. +This plugin provides a few utilities to make it more enjoyable on macOS (previously named OSX). To start using it, add the `osx` plugin to your plugins array in `~/.zshrc`: @@ -12,6 +10,27 @@ plugins=(... osx) Original author: [Sorin Ionescu](https://github.com/sorin-ionescu) +## Commands + +| Command | Description | +| :-------------- | :---------------------------------------------------- | +| `tab` | Open the current directory in a new tab | +| `split_tab` | Split the current terminal tab horizontally | +| `vsplit_tab` | Split the current terminal tab vertically | +| `ofd` | Open the current directory in a Finder window | +| `pfd` | Return the path of the frontmost Finder window | +| `pfs` | Return the current Finder selection | +| `cdf` | `cd` to the current Finder directory | +| `pushdf` | `pushd` to the current Finder directory | +| `quick-look` | Quick-Look a specified file | +| `man-preview` | Open a specified man page in Preview app | +| `showfiles` | Show hidden files | +| `hidefiles` | Hide the hidden files | +| `itunes` | DEPRECATED. Use `music` from macOS Catalina on | +| `music` | Control Apple Music. Use `music -h` for usage details | +| `spotify` | Control Spotify and search by artist, album, track… | +| `rmdsstore` | Remove .DS\_Store files recursively in a directory | + ## Acknowledgements This application makes use of the following third party scripts: @@ -38,25 +57,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - - -## Commands - -| Command | Description | -| :-------------- | :---------------------------------------------------- | -| `tab` | Open the current directory in a new tab | -| `split_tab` | Split the current terminal tab horizontally | -| `vsplit_tab` | Split the current terminal tab vertically | -| `ofd` | Open the current directory in a Finder window | -| `pfd` | Return the path of the frontmost Finder window | -| `pfs` | Return the current Finder selection | -| `cdf` | `cd` to the current Finder directory | -| `pushdf` | `pushd` to the current Finder directory | -| `quick-look` | Quick-Look a specified file | -| `man-preview` | Open a specified man page in Preview app | -| `showfiles` | Show hidden files | -| `hidefiles` | Hide the hidden files | -| `itunes` | DEPRECATED. Use `music` from macOS Catalina on | -| `music` | Control Apple Music. Use `music -h` for usage details | -| `spotify` | Control Spotify and search by artist, album, track… | -| `rmdsstore` | Remove .DS\_Store files recursively in a directory | diff --git a/plugins/perms/README.md b/plugins/perms/README.md index 324b3f3cc..ae7a36b9d 100644 --- a/plugins/perms/README.md +++ b/plugins/perms/README.md @@ -1,9 +1,15 @@ -## Perms +# Perms plugin -Plugin to handle some unix filesystem permissions quickly +Plugin to handle some unix filesystem permissions quickly. -### Usage +To use it, add `perms` to the plugins array in your zshrc file: + +```zsh +plugins=(... perms) +``` + +## Usage * `set755` recursively sets all given directories (default to .) to octal 755. * `set644` recursively sets all given files (default to .) to octal 644. -* `fixperms` is a wrapper around `set755` and `set644` applied to a specified directory or the current directory otherwise. It also prompts prior to execution unlike the other two aliases. +* `fixperms` is a wrapper around `set755` and `set644` applied to a specified directory or the current directory otherwise. It also prompts prior to execution unlike the other two aliases. diff --git a/plugins/pylint/README.md b/plugins/pylint/README.md index 8c1de88ba..31710d8a2 100644 --- a/plugins/pylint/README.md +++ b/plugins/pylint/README.md @@ -1,6 +1,7 @@ -# pylint +# pylint -This plugin adds code analysis for python through [Pylint](https://www.pylint.org/). +This plugin adds aliases and autocompletion for [Pylint](https://www.pylint.org/), +the Python code style checking tool. To use it, add `pylint` to the plugins array in your zshrc file: @@ -12,4 +13,4 @@ plugins=(... pylint) | Alias | Command | Description | | -------------| -------------------- | -------------------------------------------------------------------------------------------------------------------------| -| pylint-quick | `pylint --reports=n` | Displays a set of reports each one focusing on a particular aspect of the project, default set `no` for multiple reports | | +| pylint-quick | `pylint --reports=n` | Displays a set of reports each one focusing on a particular aspect of the project, default set `no` for multiple reports | diff --git a/plugins/pylint/pylint.plugin.zsh b/plugins/pylint/pylint.plugin.zsh index 57c7c0ac5..14cea5bef 100644 --- a/plugins/pylint/pylint.plugin.zsh +++ b/plugins/pylint/pylint.plugin.zsh @@ -1,3 +1 @@ -# Aliases alias pylint-quick='pylint --reports=n' -compdef _pylint-quick pylint-quick='pylint --reports=n' diff --git a/plugins/rails/README.md b/plugins/rails/README.md index ad83fffe8..9fb1cecf1 100644 --- a/plugins/rails/README.md +++ b/plugins/rails/README.md @@ -80,4 +80,3 @@ separately. For example: `REP rake db:migrate` will migrate the production db. | `ssp` | `ruby script/spec` | | `sc` | `ruby script/console` | | `sd` | `ruby script/server --debugger` | - diff --git a/plugins/repo/README.md b/plugins/repo/README.md index 4d9366adf..6abd23319 100644 --- a/plugins/repo/README.md +++ b/plugins/repo/README.md @@ -1,7 +1,25 @@ -## repo -**Maintainer:** [Stibbons](https://github.com/Stibbons) +# repo plugin -This plugin mainly add support automatic completion for the repo command line tool: -https://code.google.com/p/git-repo/ +This plugin mainly adds some aliases and support for automatic completion for +the [repo command line tool](https://code.google.com/p/git-repo/). -* `r` aliases `repo` +To use it, add `repo` to the plugins array in your zshrc file: + +```zsh +plugins=(... repo) +``` + +## Aliases + +| Alias | Command | +|---------|----------------------------------------| +| `r` | `repo` | +| `rra` | `repo rebase --auto-stash` | +| `rs` | `repo sync` | +| `rsrra` | `repo sync ; repo rebase --auto-stash` | +| `ru` | `repo upload` | +| `rst` | `repo status` | +| `rsto` | `repo status -o` | +| `rfa` | `repo forall -c` | +| `rfap` | `repo forall -p -c` | +| `rinf` | `repo info` | diff --git a/plugins/repo/_repo b/plugins/repo/_repo index 59e39c954..db0ecd14d 100644 --- a/plugins/repo/_repo +++ b/plugins/repo/_repo @@ -1,6 +1,5 @@ #compdef repo - __git_apply_whitespace_strategies () { declare -a strategies @@ -269,4 +268,3 @@ __repo_projects_or_all() _repo "$@" return $? - diff --git a/plugins/repo/repo.plugin.zsh b/plugins/repo/repo.plugin.zsh index 51cd32fc4..f098993f8 100644 --- a/plugins/repo/repo.plugin.zsh +++ b/plugins/repo/repo.plugin.zsh @@ -1,30 +1,10 @@ -# Aliases alias r='repo' -compdef _repo r=repo - alias rra='repo rebase --auto-stash' -compdef _repo rra='repo rebase --auto-stash' - alias rs='repo sync' -compdef _repo rs='repo sync' - alias rsrra='repo sync ; repo rebase --auto-stash' -compdef _repo rsrra='repo sync ; repo rebase --auto-stash' - alias ru='repo upload' -compdef _repo ru='repo upload' - alias rst='repo status' -compdef _repo rst='repo status' - alias rsto='repo status -o' -compdef _repo rsto='repo status -o' - alias rfa='repo forall -c' -compdef _repo rfa='repo forall -c' - alias rfap='repo forall -p -c' -compdef _repo rfap='repo forall -p -c' - alias rinf='repo info' -compdef _repo rinf='repo info' diff --git a/plugins/rvm/README.md b/plugins/rvm/README.md index 9d6fd8f85..1ed8d46a2 100644 --- a/plugins/rvm/README.md +++ b/plugins/rvm/README.md @@ -8,7 +8,8 @@ To use it, add `rvm` to the plugins array in your zshrc file: plugins=(... rvm) ``` -## Functions +## Aliases + | Alias | Command | |----------------|----------------------| | `rb18` | `rvm use ruby-1.8.7` | diff --git a/plugins/scala/README.md b/plugins/scala/README.md index 957261d9e..91a322162 100644 --- a/plugins/scala/README.md +++ b/plugins/scala/README.md @@ -1,15 +1,16 @@ -## Scala plugin +# Scala plugin Completion script for [scala and scalac](https://www.scala-lang.org/) commands. To use it, add `scala` to the plugins array of your zshrc file: -``` + +```zsh plugins=(... scala) ``` ## Aliases -| Command | Description | -|------------------|---------------------------------------------------------------------------------| -| `scala` | Run code in the Scala language | -| `scalac` | Compiler for the Scala language | +| Command | Description | +|----------|---------------------------------| +| `scala` | Run code in the Scala language | +| `scalac` | Compiler for the Scala language | diff --git a/plugins/sdk/README.md b/plugins/sdk/README.md index b237f3b4c..1eda5d390 100644 --- a/plugins/sdk/README.md +++ b/plugins/sdk/README.md @@ -3,6 +3,12 @@ Plugin for SDKMAN, a tool for managing parallel versions of multiple Software Development Kits on most Unix based systems. Provides autocompletion for all known commands. +To use it, add `sdk` to your plugins array in your zshrc file: + +```zsh +plugins=(... sdk) +``` + ## Requirements - * [SDKMAN](http://sdkman.io/) +* [SDKMAN](http://sdkman.io/) diff --git a/plugins/sprunge/README.md b/plugins/sprunge/README.md index 2a363d3bd..28ed1834a 100644 --- a/plugins/sprunge/README.md +++ b/plugins/sprunge/README.md @@ -3,7 +3,8 @@ This plugin uploads data and fetch URL from the pastebin http://sprunge.us To enable it, add 'sprunge' to your plugins: -``` + +```zsh plugins=(... sprunge) ``` diff --git a/plugins/sudo/README.md b/plugins/sudo/README.md index 25eb85829..4f3973ef8 100644 --- a/plugins/sudo/README.md +++ b/plugins/sudo/README.md @@ -2,25 +2,13 @@ Easily prefix your current or previous commands with `sudo` by pressing esc twice -## Enabling the plugin +To use it, add `sudo` to the plugins array in your zshrc file: -1. Open your `.zshrc` file and add `sudo` in the plugins section: +```zsh +plugins=(... sudo) +``` - ```zsh - plugins=( - # all your enabled plugins - sudo - ) - ``` - -2. Restart your shell or restart your Terminal session: - - ```console - $ exec zsh - $ - ``` - -## Usage examples +## Usage ### Current typed commands diff --git a/plugins/supervisor/README.md b/plugins/supervisor/README.md index 1eacea6d3..a060ff483 100644 --- a/plugins/supervisor/README.md +++ b/plugins/supervisor/README.md @@ -5,6 +5,7 @@ Supervisor is a client/server system that allows its users to monitor and contro of processes on UNIX-like operating systems. To use it, add `supervisor` to the plugins array in your zshrc file: + ```zsh plugins=(... supervisor) ``` diff --git a/plugins/svn-fast-info/README.md b/plugins/svn-fast-info/README.md index 04c596fd8..771378254 100644 --- a/plugins/svn-fast-info/README.md +++ b/plugins/svn-fast-info/README.md @@ -4,6 +4,7 @@ Faster alternative to the main SVN plugin implementation. Works with svn 1.6 and Use as a drop-in replacement to the svn plugin, not as complementary. To use it, add `svn-fast-info` to the plugins array in your zshrc file: + ```zsh plugins=(... svn-fast-info) ``` diff --git a/plugins/taskwarrior/README.md b/plugins/taskwarrior/README.md index 2a86510dd..e77e4528a 100644 --- a/plugins/taskwarrior/README.md +++ b/plugins/taskwarrior/README.md @@ -4,10 +4,15 @@ This plugin adds smart tab completion for [TaskWarrior](https://taskwarrior.org/ It uses the zsh tab completion script (`_task`) shipped with TaskWarrior for the completion definitions. -The latest version pulled in from the official project is of January 1st, 2015. +To use it, add `taskwarrior` to the plugins array in your zshrc file: +```zsh +plugins=(... taskwarrior) +``` ## Examples Typing `task [TAB]` will give you a list of commands, `task 66[TAB]` shows a list of available modifications for that task, etcetera. + +The latest version pulled in from the official project is of January 1st, 2015. diff --git a/plugins/textmate/README.md b/plugins/textmate/README.md index 9fd342135..e6c1943f4 100644 --- a/plugins/textmate/README.md +++ b/plugins/textmate/README.md @@ -3,7 +3,8 @@ The plugin adds a function for the [TextMate](https://macromates.com) editor. To use it, add `textmate` to the plugins array of your zshrc file: -``` + +```zsh plugins=(... textmate) ``` diff --git a/plugins/tmux/README.md b/plugins/tmux/README.md index db57f5be2..2ceaf1ad5 100644 --- a/plugins/tmux/README.md +++ b/plugins/tmux/README.md @@ -7,7 +7,8 @@ To use it add `tmux` to the plugins array in your zshrc file. plugins=(... tmux) ``` -The plugin also supports the following - +The plugin also supports the following: + - determines if tmux is installed or not, if not, prompts user to install tmux - determines if the terminal supports the 256 colors or not, sets the appropriate configuration variable - sets the correct local config file to use @@ -24,7 +25,6 @@ The plugin also supports the following - | `tkss` | tmux kill-session -t | Terminate named running tmux session | | `tmux` | `_zsh_tmux_plugin_run` | Start a new tmux session | - ## Configuration Variables | Variable | Description | diff --git a/plugins/tmuxinator/README.md b/plugins/tmuxinator/README.md index 994d8d46d..8709204a0 100644 --- a/plugins/tmuxinator/README.md +++ b/plugins/tmuxinator/README.md @@ -11,9 +11,9 @@ plugins=(... tmuxinator) ## Aliases -| Alias | Command | Description | -| ------ | ---------------- | ------------------------ | -| `txs ` | tmuxinator start | Start Tmuxinator | -| `txo ` | tmuxinator open | Open project for editing | -| `txn ` | tmuxinator new | Create project | -| `txl ` | tmuxinator list | List projects | +| Alias | Command | Description | +| ----- | ---------------- | ------------------------ | +| `txs` | tmuxinator start | Start Tmuxinator | +| `txo` | tmuxinator open | Open project for editing | +| `txn` | tmuxinator new | Create project | +| `txl` | tmuxinator list | List projects | diff --git a/plugins/wakeonlan/README b/plugins/wakeonlan/README.md similarity index 67% rename from plugins/wakeonlan/README rename to plugins/wakeonlan/README.md index 16fdd4587..3fcb6d7f1 100644 --- a/plugins/wakeonlan/README +++ b/plugins/wakeonlan/README.md @@ -1,9 +1,17 @@ +# wakeonlan + This plugin provides a wrapper around the "wakeonlan" tool available from most -distributions' package repositories, or from the following website: +distributions' package repositories, or from [the following website](https://github.com/jpoliv/wakeonlan). -http://gsd.di.uminho.pt/jpo/software/wakeonlan/ +To use it, add `wakeonlan` to the plugins array in your zshrc file: -In order to use this wrapper, create the ~/.wakeonlan directory, and place in +```zsh +plugins=(... wakeonlan) +``` + +## Usage + +In order to use this wrapper, create the `~/.wakeonlan` directory, and place in that directory one file for each device you would like to be able to wake. Give the file a name that describes the device, such as its hostname. Each file should contain a line with the mac address of the target device and the network @@ -12,15 +20,21 @@ broadcast address. For instance, there might be a file ~/.wakeonlan/leto with the following contents: +``` 00:11:22:33:44:55:66 192.168.0.255 +``` To wake that device, use the following command: -# wake leto +```console +$ wake leto +``` The available device names will be autocompleted, so: -# wake +```console +$ wake +``` ...will suggest "leto", along with any other configuration files that were placed in the ~/.wakeonlan directory. diff --git a/plugins/yii/README.md b/plugins/yii/README.md index f1b72e916..9636149ca 100644 --- a/plugins/yii/README.md +++ b/plugins/yii/README.md @@ -3,7 +3,8 @@ The plugin adds autocomplete commands and subcommands for [yii](https://www.yiiframework.com/). To use it, add `yii` to the plugins array of your zshrc file: -``` + +```zsh plugins=(... yii) ``` diff --git a/plugins/yii2/yii2.plugin.zsh b/plugins/yii2/yii2.plugin.zsh index e8993adf4..713f2ef2a 100644 --- a/plugins/yii2/yii2.plugin.zsh +++ b/plugins/yii2/yii2.plugin.zsh @@ -26,4 +26,4 @@ _yii2 () { fi } -compdef _yii2 yii \ No newline at end of file +compdef _yii2 yii diff --git a/plugins/yum/README.md b/plugins/yum/README.md index 8043421d8..fec584911 100644 --- a/plugins/yum/README.md +++ b/plugins/yum/README.md @@ -4,7 +4,7 @@ This plugin adds useful aliases for common [Yum](http://yum.baseurl.org/) comman To use it, add `yum` to the plugins array in your zshrc file: -``` +```zsh plugins=(... yum) ``` diff --git a/plugins/zeus/README.md b/plugins/zeus/README.md index 84ed70c91..0131f70d5 100644 --- a/plugins/zeus/README.md +++ b/plugins/zeus/README.md @@ -1,57 +1,50 @@ -## zeus -**Maintainer:** [b4mboo](https://github.com/b4mboo) +# zeus plugin -* `zi` aliases `zeus init` -* `zinit` aliases `zeus init` +[Zeus](https://github.com/burke/zeus) preloads your Rails environment and forks that +process whenever needed. This effectively speeds up Rails' boot process to under 1 sec. +This plugin adds autocompletion for zeus and aliases for common usage. -* `zs` aliases `zeus start` -* `ztart` aliases `zeus start` +To use it, add `zeus` to the plugins array in your zshrc file: -* `zc` aliases `zeus console` -* `zonsole` aliases `zeus console` +```zsh +plugins=(... zeus) +``` -* `zsr` aliases `zeus server` -* `zerver` aliases `zeus server` +You also need to have the `zeus` gem installed. -* `zr` aliases `zeus rake` -* `zake` aliases `zeus rake` - -* `zg` aliases `zeus generate` -* `zenerate` aliases `zeus generate` - -* `zrn` aliases `zeus runner` -* `zunner` aliases `zeus runner` - -* `zcu` aliases `zeus cucumber` -* `zucumber` aliases `zeus cucumber` -* `zwip` aliases `zeus cucumber --profile wip` - -* `zspec` aliases `zeus rspec` - -* `zt` aliases `zeus test` -* `zest` aliases `zeus test` - -* `zu` aliases `zeus test test/unit/*` -* `zunits` aliases `zeus test test/unit/*` - -* `zf` aliases `zeus test test/functional/*` -* `zunctional` aliases `zeus test test/functional/*` - -* `za` aliases `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` -* `zall` aliases `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` - -* `zsw` aliases `rm .zeus.sock` -* `zweep` aliases `rm .zeus.sock` - -* `zdbr` aliases `zeus rake db:reset db:test:prepare` -* `zdbreset` aliases `zeus rake db:reset db:test:prepare` - -* `zdbm` aliases `zeus rake db:migrate db:test:prepare` -* `zdbmigrate` aliases `zeus rake db:migrate db:test:prepare` - -* `zdbc` aliases `zeus rake db:create` - -* `zdbcm` aliases `zeus rake db:create db:migrate db:test:prepare` - -## Installation -Add zeus to the plugins line of your `.zshconfig` file (e.g. `plugins=(rails git zeus)`) +| Alias | Command | +|:-------------|:-------------------------------------------------------------------| +| _zi_ | `zeus init` | +| _zinit_ | `zeus init` | +| _zs_ | `zeus start` | +| _ztart_ | `zeus start` | +| _zc_ | `zeus console` | +| _zonsole_ | `zeus console` | +| _zsr_ | `zeus server` | +| _zerver_ | `zeus server` | +| _zr_ | `noglob zeus rake` | +| _zake_ | `noglob zeus rake` | +| _zg_ | `zeus generate` | +| _zenerate_ | `zeus generate` | +| _zrn_ | `zeus runner` | +| _zunner_ | `zeus runner` | +| _zcu_ | `zeus cucumber` | +| _zucumber_ | `zeus cucumber` | +| _zwip_ | `zeus cucumber --profile wip` | +| _zspec_ | `zeus rspec` | +| _zt_ | `zeus test` | +| _zest_ | `zeus test` | +| _zu_ | `zeus test test/unit/*` | +| _zunits_ | `zeus test test/unit/*` | +| _zf_ | `zeus test test/functional/*` | +| _zunctional_ | `zeus test test/functional/*` | +| _za_ | `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` | +| _zall_ | `zeus test test/unit/*; zeus test test/functional/; zeus cucumber` | +| _zsw_ | `rm .zeus.sock` | +| _zweep_ | `rm .zeus.sock` | +| _zdbr_ | `zeus rake db:reset db:test:prepare` | +| _zdbreset_ | `zeus rake db:reset db:test:prepare` | +| _zdbm_ | `zeus rake db:migrate db:test:prepare` | +| _zdbmigrate_ | `zeus rake db:migrate db:test:prepare` | +| _zdbc_ | `zeus rake db:create` | +| _zdbcm_ | `zeus rake db:create db:migrate db:test:prepare` |