summaryrefslogtreecommitdiff
path: root/plugins/bazel/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/bazel/README.md')
-rw-r--r--plugins/bazel/README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/plugins/bazel/README.md b/plugins/bazel/README.md
index fc375d219..b0c34a15f 100644
--- a/plugins/bazel/README.md
+++ b/plugins/bazel/README.md
@@ -1,7 +1,7 @@
# Bazel plugin
-This plugin adds completion for [bazel](https://bazel.build), an open-source build and
-test tool that scalably supports multi-language and multi-platform projects.
+This plugin adds completion and aliases for [bazel](https://bazel.build), an open-source build and test tool
+that scalably supports multi-language and multi-platform projects.
To use it, add `bazel` to the plugins array in your zshrc file:
@@ -12,3 +12,18 @@ plugins=(... bazel)
The plugin has a copy of [the completion script from the git repository][1].
[1]: https://github.com/bazelbuild/bazel/blob/master/scripts/zsh_completion/_bazel
+
+## Aliases
+
+| Alias | Command | Description |
+| ----- | ------------- | ------------------------- |
+| bzb | `bazel build` | The `bazel build` command |
+| bzt | `bazel test` | The `bazel test` command |
+| bzr | `bazel run` | The `bazel run` command |
+| bzq | `bazel query` | The `bazel query` command |
+
+## Functions
+
+| Function | Description |
+| -------- | -------------------------------- |
+| sri-hash | Generate SRI hash used by bzlmod |