summaryrefslogtreecommitdiffstats
path: root/.config/zsh/oh-my-zsh/plugins/aliases/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
commit8a2e1006b3b272126332aa064f3ad95387129544 (patch)
tree944c80ac612a65980d94a54ba11b6c7102037ecf /.config/zsh/oh-my-zsh/plugins/aliases/README.md
parentdcbb16d8b08ff5956abef5e6478b59df2e93ad35 (diff)
downloaddotfiles-master.tar.gz
dotfiles-master.tar.bz2
dotfiles-master.zip
new dot filesHEADmaster
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/aliases/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/aliases/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/aliases/README.md b/.config/zsh/oh-my-zsh/plugins/aliases/README.md
new file mode 100644
index 0000000..bfb6ab8
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/plugins/aliases/README.md
@@ -0,0 +1,22 @@
+# Aliases cheatsheet
+
+**Maintainer:** [@hqingyi](https://github.com/hqingyi)
+
+With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts
+that are currently available based on the plugins you have enabled.
+
+To use it, add `aliases` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(aliases)
+```
+
+Requirements: Python needs to be installed.
+
+## Usage
+
+- `acs`: show all aliases by group.
+
+- `acs <keyword>`: filter aliases by `<keyword>` and highlight.
+
+ ![screenshot](https://cloud.githubusercontent.com/assets/3602957/11581913/cb54fb8a-9a82-11e5-846b-5a67f67ad9ad.png)