diff options
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/dash/README.md | 28 | ||||
| -rw-r--r-- | plugins/dash/dash.plugin.zsh | 52 | ||||
| -rw-r--r-- | plugins/mysql-macports/README.md | 20 | ||||
| -rw-r--r-- | plugins/redis-cli/README.md | 15 | 
4 files changed, 86 insertions, 29 deletions
diff --git a/plugins/dash/README.md b/plugins/dash/README.md new file mode 100644 index 000000000..0ca3e4e44 --- /dev/null +++ b/plugins/dash/README.md @@ -0,0 +1,28 @@ +# Dash plugin + +This plugin adds command line functionality for [Dash](https://kapeli.com/dash), +an API Documentation Browser for macOS. This plugin requires Dash to be installed +to work. + +To use it, add `dash` to the plugins array in your zshrc file: + +```zsh +plugins=(... dash) +``` + +## Usage + +- Open and switch to the dash application. +``` +dash +``` + +- Query for something in dash app: `dash query` +``` +dash golang  +``` + +- You can optionally provide a keyword: `dash [keyword:]query` +``` +dash python:tuple +``` diff --git a/plugins/dash/dash.plugin.zsh b/plugins/dash/dash.plugin.zsh index b00d4877e..ace2e33c1 100644 --- a/plugins/dash/dash.plugin.zsh +++ b/plugins/dash/dash.plugin.zsh @@ -35,36 +35,30 @@ _dash() {            if [[ "$locator" == "platform" ]]; then              # Since these are the only special cases right now, let's not do the              # expensive processing unless we have to -            if [[ "$keyword" == "python" ||  "$keyword" == "java" || \ -                  "$keyword" == "qt" || "$keyword" == "cocs2d" ]]; then +            if [[ "$keyword" = (python|java|qt|cocos2d) ]]; then                docsetName=`echo $doc | grep -Eo "docsetName = .*?;" | sed -e "s/docsetName = \(.*\);/\1/" -e "s/[\":]//g"` -              if [[ "$keyword" == "python" ]]; then -                if [[ "$docsetName" == "Python 2" ]]; then -                  keyword="python2" -                elif [[ "$docsetName" == "Python 3" ]]; then -                  keyword="python3" -                fi -              elif [[ "$keyword" == "java" ]]; then -                if [[ "$docsetName" == "Java SE7" ]]; then -                  keyword="java7" -                elif [[ "$docsetName" == "Java SE6" ]]; then -                  keyword="java6" -                elif [[ "$docsetName" == "Java SE8" ]]; then -                  keyword="java8" -                fi -              elif [[ "$keyword" == "qt" ]]; then -                if [[ "$docsetName" == "Qt 5" ]]; then -                  keyword="qt5" -                elif [[ "$docsetName" == "Qt 4" ]]; then -                  keyword="qt4" -                elif [[ "$docsetName" == "Qt" ]]; then -                  keyword="qt4" -                fi -              elif [[ "$keyword" == "cocos2d" ]]; then -                if [[ "$docsetName" == "Cocos3D" ]]; then -                  keyword="cocos3d" -                fi -              fi +              case "$keyword" in +                python) +                  case "$docsetName" in +                    "Python 2") keyword="python2" ;; +                    "Python 3") keyword="python3" ;; +                  esac ;; +                java) +                  case "$docsetName" in +                    "Java SE7") keyword="java7" ;; +                    "Java SE6") keyword="java6" ;; +                    "Java SE8") keyword="java8" ;; +                  esac ;; +                qt) +                  case "$docsetName" in +                    "Qt 5") keyword="qt5" ;; +                    "Qt 4"|Qt) keyword="qt4" ;; +                  esac ;; +                cocos2d) +                  case "$docsetName" in +                    Cocos3D) keyword="cocos3d" ;; +                  esac ;; +              esac              fi            fi diff --git a/plugins/mysql-macports/README.md b/plugins/mysql-macports/README.md new file mode 100644 index 000000000..a4224d9c0 --- /dev/null +++ b/plugins/mysql-macports/README.md @@ -0,0 +1,20 @@ +# MySQL-Macports plugin + +This plugin adds aliases for some of the commonly used [MySQL](https://www.mysql.com/) commands when installed using [MacPorts](https://www.macports.org/) on macOS. + +To use it, add `mysql-macports` to the plugins array in your zshrc file: + +```zsh +plugins=(... mysql-macports) +``` + +For instructions on how to install MySQL using MacPorts, read the [MacPorts wiki](https://trac.macports.org/wiki/howto/MySQL/). + +## 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. | diff --git a/plugins/redis-cli/README.md b/plugins/redis-cli/README.md new file mode 100644 index 000000000..bb6e94a0f --- /dev/null +++ b/plugins/redis-cli/README.md @@ -0,0 +1,15 @@ +# Redis-CLI + +This plugin adds [redis-cli](https://redis.io/topics/rediscli) completion, based off of Homebrew completion. + +To use it, add `redis-cli` to the plugins array in your zshrc file: + +```zsh +plugins=(... redis-cli) +``` + +## Requirements + +In order to make this work, you will need to have redis installed. + +More info on the usage and install: https://redis.io/topics/quickstart  | 
