Conventions

leaf command: leaf commands are the commands at the last of the CLI that takes arguments, options and flags, e.g the show command below

node command: node commands are the commands at the middle or first of the CLI that contains sub-commands, e.g the remote command below

git remote show origin

arguments: arguments are command line arguments that required at the leaf command

flags: flags are command line options that has no arguments, e.g --flag or -f (short flag).

options: options are command line options that has arguments, e.g --name Sam or -n Sam, also --name=Sam or -nSam.

When used on function expressions, @cast and @main have the same convention on how they convert your expressions to commands, these are

• function arguments are parsed as command arguments:
  • value will be converted automatically if arguments has type annotation
  • optional arguments are allowed
• function keyword arguments are parsed as command flags or options:
  • keyword arguments must have default value
  • keyword arguments of type Bool can only have false as default value, which will be treated as flags that allow short flags.
  • value will be converted automatically if keyword arguments has type annotation
• function doc string can use section names: Arguments, Options and Flags to annotate your CLI:
  • short options or short flags can be declared via -f, flag or -o, --option <name> (see example below)