Skip to content

Read a command's usage

$ grim help create-project

You remember the command and not the flag. grim help prints the same reference these pages carry under Arguments and options, taken from the grim you have installed, so it is the version that is true for your machine.

Usage

$ grim help create-project          # description, usage, arguments, options
$ grim create-project --help        # the same thing, the way most people type it
$ grim help update --format=md      # as Markdown

It runs from anywhere and needs no project.

Arguments and options

Display help for a command

Usage

grim help [--format FORMAT] [--raw] [--] [<command_name>]

Arguments

Argument Description
command_name The command name (optional, default: help)

Options

Option Description
--format=FORMAT The output format (txt, xml, json, or md) (default: txt)
--raw To output raw command help

What it actually does

  1. Looks the command up by name. A unique abbreviation is accepted.
  2. Prints its description, usage line, arguments and options, followed by the options every command shares, such as --no-interaction and -v.

With no command name it prints the help of help itself.

After it finishes

For the list of all commands rather than the details of one, see grim list.