summaryrefslogtreecommitdiff
path: root/plugins/localstack/README.md
diff options
context:
space:
mode:
authorEduardo Dos Santos Vilke <eduardo.svilke@gmail.com>2024-09-05 14:40:19 -0300
committerGitHub <noreply@github.com>2024-09-05 19:40:19 +0200
commit2acfe1aa0e0c6a9c316fbec508f43dcf9f292ce3 (patch)
tree4412be86a020eb29d4c652c88d21265d274d2834 /plugins/localstack/README.md
parente50dd3417c8b9e072593b6c14473e1360bd88b02 (diff)
downloadzsh-2acfe1aa0e0c6a9c316fbec508f43dcf9f292ce3.tar.gz
zsh-2acfe1aa0e0c6a9c316fbec508f43dcf9f292ce3.tar.bz2
zsh-2acfe1aa0e0c6a9c316fbec508f43dcf9f292ce3.zip
feat(localstack): add plugin (#12595)
Diffstat (limited to 'plugins/localstack/README.md')
-rw-r--r--plugins/localstack/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/localstack/README.md b/plugins/localstack/README.md
new file mode 100644
index 000000000..2c71e9edf
--- /dev/null
+++ b/plugins/localstack/README.md
@@ -0,0 +1,24 @@
+# Localstack plugin #
+
+CLI support for LOCALSTACK interaction
+
+## Description ##
+To use it, add `localstack` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... localstack)
+```
+
+## Usage ##
+
+This plugin supplies one command, `lsk`, through which all its features are exposed.
+
+## Commands
+
+| Command | Description |
+| :------------ | :-------------------------------------------------------------------- |
+| `lsk sqs-send <queue> <message.json>` | sends a given message in sqs to a given queue |
+
+## Examples
+
+![staging](sqs-send-result.png)