summaryrefslogtreecommitdiff
path: root/plugins/grc
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/grc')
-rw-r--r--plugins/grc/README.md15
-rw-r--r--plugins/grc/grc.plugin.zsh17
2 files changed, 32 insertions, 0 deletions
diff --git a/plugins/grc/README.md b/plugins/grc/README.md
new file mode 100644
index 000000000..515e87640
--- /dev/null
+++ b/plugins/grc/README.md
@@ -0,0 +1,15 @@
+# Generic Colouriser plugin
+
+This plugin adds wrappers for commands supported by [Generic Colouriser](https://github.com/garabik/grc):
+
+To use it, add `grc` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... grc)
+```
+
+## Commands
+
+The plugin sources the bundled alias generator from the installation, available at `/etc/grc.zsh`.
+The complete list of wrapped commands may vary depending on the installed version of `grc`, look
+at the file mentioned above (`/etc/grc.zsh`) to see which commands are wrapped.
diff --git a/plugins/grc/grc.plugin.zsh b/plugins/grc/grc.plugin.zsh
new file mode 100644
index 000000000..b709b9e02
--- /dev/null
+++ b/plugins/grc/grc.plugin.zsh
@@ -0,0 +1,17 @@
+#!/usr/bin/env zsh
+
+# common grc.zsh paths
+files=(
+ /etc/grc.zsh # default
+ /usr/local/etc/grc.zsh # homebrew
+)
+
+# verify the file is readable and source it
+for file in $files; do
+ if [[ -r "$file" ]]; then
+ source "$file"
+ break
+ fi
+done
+
+unset file files