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.

    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.