summaryrefslogtreecommitdiff
path: root/examples/cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cli/README.md')
-rw-r--r--examples/cli/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/examples/cli/README.md b/examples/cli/README.md
new file mode 100644
index 0000000..d393a9c
--- /dev/null
+++ b/examples/cli/README.md
@@ -0,0 +1,26 @@
+# Example: Via CLI
+
+Uses RCM through the `rcm` command-line tool.
+
+## Usage
+
+```sh
+# Dry run — show what would change, make no changes
+rcm config.rb --dry
+
+# Verbose output
+rcm config.rb --debug
+
+# Limit execution to specific hosts
+rcm config.rb --hosts earth,mars
+
+# Apply configuration
+rcm config.rb
+```
+
+## What it does
+
+- Creates `/tmp/example/hello.txt` with static content (parent directory created automatically)
+- Creates `/tmp/example/info.txt` from an inline ERB template containing the hostname and current date
+
+Both operations only run when the current hostname is `earth`.