stow/oh-my-zsh/.oh-my-zsh/plugins/alias-finder/README.md

   1 # alias-finder plugin
   2
   3 This plugin searches the defined aliases and outputs any that match the command inputted. This makes learning new aliases easier.
   4
   5 To use it, add `alias-finder` to the `plugins` array of your zshrc file:
   6 ```
   7 plugins=(... alias-finder)
   8 ```
   9
  10 ## Usage
  11 To see if there is an alias defined for the command, pass it as an argument to `alias-finder`. This can also run automatically before each command you input - add `ZSH_ALIAS_FINDER_AUTOMATIC=true` to your zshrc if you want this.
  12
  13 ## Options
  14
  15 - Use `--longer` or `-l` to allow the aliases to be longer than the input (match aliases if they contain the input).
  16 - Use `--exact` or `-e` to avoid matching aliases that are shorter than the input.
  17
  18 ## Examples
  19 ```
  20 $ alias-finder "git pull"
  21 gl='git pull'
  22 g=git
  23 ```
  24 ```
  25 $ alias-finder "web_search google oh my zsh"
  26 google='web_search google'
  27 ```
  28 ```
  29 $ alias-finder "git commit -v"
  30 gc="git commit -v"
  31 g=git
  32 ```
  33 ```
  34 $ alias-finder -e "git commit -v"
  35 gc='git commit -v'
  36 ```
  37 ```
  38 $ alias-finder -l "git commit -v"
  39 gc='git commit -v'
  40 'gc!'='git commit -v --amend'
  41 gca='git commit -v -a'
  42 'gca!'='git commit -v -a --amend'
  43 'gcan!'='git commit -v -a --no-edit --amend'
  44 'gcans!'='git commit -v -a -s --no-edit --amend'
  45 'gcn!'='git commit -v --no-edit --amend'
  46 ```