Skip to content

Commit

Permalink
docs(alias-finder): add some examples (#12502)
Browse files Browse the repository at this point in the history
  • Loading branch information
timabell committed Jun 13, 2024
1 parent 8908e6d commit 0c9b42a
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion plugins/alias-finder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This plugin searches the defined aliases and outputs any that match the command inputted. This makes learning new aliases easier.

## Usage
## Setup

To use it, add `alias-finder` to the `plugins` array of your zshrc file:
```
Expand All @@ -22,6 +22,41 @@ zstyle ':omz:plugins:alias-finder' cheaper yes # disabled by default

As you can see, options are also available with zstyle.

## Usage

When you execute a command alias finder will look at your defined aliases and suggest shorter aliases you could have used, for example:

Running the un-aliased `git status` command:
```sh
╭─tim@fox ~/repo/gitopolis ‹main›
╰─$ git status

gst='git status' # <=== shorter suggestion from alias-finder

On branch main
Your branch is up-to-date with 'origin/main'.
nothing to commit, working tree clean
```

Running a shorter `git st` alias from `.gitconfig` that it suggested :
```sh
╭─tim@fox ~/repo/gitopolis ‹main›
╰─$ git st
gs='git st' # <=== shorter suggestion from alias-finder
## main...origin/main
```

Running the shortest `gs` shell alias that it found:
```sh
╭─tim@fox ~/repo/gitopolis ‹main›
╰─$ gs
# <=== no suggestions alias-finder because this is the shortest
## main...origin/main
```

![image](https://github.com/ohmyzsh/ohmyzsh/assets/19378/39642750-fb10-4f1a-b7f9-f36789eeb01b)


### Options

> In order to clarify, let's say `alias a=abc` has source 'abc' and destination 'a'.
Expand Down

0 comments on commit 0c9b42a

Please sign in to comment.