Documentation

Edit on GitHub

PLEASE NOTE: This document applies to an unreleased version of rash. It is strongly recommended that you only use official releases of rash, as unreleased versions are subject to changes and incompatibilities that will not be supported in the official releases.

If you are using an official release version of Rash, you should refer to the documentation for your specific version.

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

Parser

Elements are parsed using usages and automatically added to your rash variables.

Commands are parsed as false by default and when are passed they will appear as true:

{
  "options": {
    "apply": false,
    "dry_run": false,
    "help": false,
    "number": "10",
    "timeout": null,
    "version": false,
    "q": true
  },
  "port": "443"
}

Note: help is a special case because if help is passed as argument or option, the program will show all documentation and after that exit 0.

Positional arguments, if exists, they are parsed as arrays:

{
    "argument": "value",
    "repeating-argument": ["value1", "value2"...],
}

If they don’t appear they will be omitted from vars.