Bob\Cli::formatUsage PHP Method

formatUsage() protected method

protected formatUsage ( )
    protected function formatUsage()
    {
        $version = \Bob::VERSION;
        $bin = basename($_SERVER['SCRIPT_NAME']);
        return <<<HELPTEXT
bob {$version}

Usage:
  {$bin}
  {$bin} [VAR=VALUE...] [TASK...]
  {$bin} --init
  {$bin} -t|--tasks
  {$bin} -h|--help

Arguments:
  TASK:
    One or more task names to run. Task names can be everything as
    long as they don't contain spaces.
  VAR=VALUE:
    One or more environment variable definitions.
    These get placed in the \$_ENV array.

Options:
  -i|--init:
    Creates an empty `bob_config.php` in the current working
    directory if none exists.
  -t|--tasks:
    Displays a fancy list of tasks and their descriptions
  -A|--all:
    Shows all tasks, even file tasks and tasks without description.
  -C|--chdir <dir>:
    Changes the working directory to <dir> before running tasks.
  -T|--trace:
    Logs trace messages to STDERR
  -f|--force:
    Force to run all tasks, even if they're not needed
  -v|--verbose:
    Be more verbose.
  -h|--help:
    Displays this message


HELPTEXT;
    }