summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/command_instead_of_shell.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/ansiblelint/rules/command_instead_of_shell.md')
-rw-r--r--src/ansiblelint/rules/command_instead_of_shell.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/ansiblelint/rules/command_instead_of_shell.md b/src/ansiblelint/rules/command_instead_of_shell.md
new file mode 100644
index 0000000..0abf69d
--- /dev/null
+++ b/src/ansiblelint/rules/command_instead_of_shell.md
@@ -0,0 +1,30 @@
+# command-instead-of-shell
+
+This rule identifies uses of `shell` modules instead of a `command` one when
+this is not really needed. Shell is considerably slower than command and should
+be avoided unless there is a special need for using shell features, like
+environment variable expansion or chaining multiple commands using pipes.
+
+## Problematic Code
+
+```yaml
+---
+- name: Problematic example
+ hosts: localhost
+ tasks:
+ - name: Echo a message
+ ansible.builtin.shell: echo hello # <-- command is better in this case
+ changed_when: false
+```
+
+## Correct Code
+
+```yaml
+---
+- name: Correct example
+ hosts: localhost
+ tasks:
+ - name: Echo a message
+ ansible.builtin.command: echo hello
+ changed_when: false
+```