diff options
| author | Paul Buetow <paul@buetow.org> | 2026-03-01 20:16:17 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-03-01 20:16:17 +0200 |
| commit | 4c2d1e5b2ee0792b1a8ca3b330fd391c6bdb8285 (patch) | |
| tree | 318249d372ab9e99ed3665ad204f41b09c4db6ba /examples/cli | |
| parent | 876a5959cedd3699b2c3eccc71ed78badc3bad55 (diff) | |
add README.md to each example directory with usage instructions
Diffstat (limited to 'examples/cli')
| -rw-r--r-- | examples/cli/README.md | 26 |
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`. |
