From 4c2d1e5b2ee0792b1a8ca3b330fd391c6bdb8285 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 1 Mar 2026 20:16:17 +0200 Subject: add README.md to each example directory with usage instructions --- examples/cli/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 examples/cli/README.md (limited to 'examples/cli') 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`. -- cgit v1.2.3