summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/pre-commit/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/pre-commit/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/pre-commit/README.md')
-rw-r--r--oh-my-zsh/plugins/pre-commit/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/pre-commit/README.md b/oh-my-zsh/plugins/pre-commit/README.md
new file mode 100644
index 0000000..e6d80d3
--- /dev/null
+++ b/oh-my-zsh/plugins/pre-commit/README.md
@@ -0,0 +1,19 @@
+# Pre-commit plugin
+
+This plugin adds aliases for common commands of [pre-commit](https://pre-commit.com/).
+
+To use this plugin, add it to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... pre-commit)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| ------- | -------------------------------------- | ------------------------------------------------------ |
+| prc | `pre-commit` | The `pre-commit` command |
+| prcau | `pre-commit autoupdate` | Update hooks automatically |
+| prcr | `pre-commit run` | The `pre-commit run` command |
+| prcra | `pre-commit run --all-files` | Run pre-commit hooks on all files |
+| prcrf | `pre-commit run --files` | Run pre-commit hooks on a given list of files |