Documentation

PLEASE NOTE: This document applies to v2.6 version and not to the latest stable release v2.9

Documentation for other releases can be found by using the version selector in the left bottom of any doc page.

Command-line interfaces

rash has an integrated command-line parser based in the documentation of your script.

This is an ad-hoc implementation based in Docopt. The main idea behind is to write the documentation and rash automatically parses arguments based on it.

E.g.:

#!/usr/bin/env -S rash --
#
# Copy files from source to dest dir
#
# Usage:
#   copy.rh [options] <source>... <dest>
#   copy.rh
#
# Options:
#   -h --help    show this help message and exit
#   --mode MODE  dest file permissions [default: 0644]

- copy:
    src: "{{ item }}"
    dest: "{{ dest }}/{{ item | split('/') | last }}"
    mode: "{{ options.mode }}"
  loop: "{{ source | default([]) }}"