Skip to content

See every command

$ grim list server

You know there is a command for it and not what it is called. grim list prints all of them with a one-line description each, grouped by namespace. Plain grim with no arguments does the same.

Usage

$ grim list                   # every command, grouped
$ grim list server            # only server:*, including server:dev:*
$ grim list --raw             # names and descriptions, no decoration
$ grim list --format=json     # for a script

It runs from anywhere and needs no project.

Arguments and options

List commands

Usage

grim list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

Arguments

Argument Description
namespace The namespace name (optional)

Options

Option Description
--raw To output raw command list
--format=FORMAT The output format (txt, xml, json, or md) (default: txt)
--short To skip describing commands' arguments

What it actually does

  1. Prints the grim version and the options every command shares. --raw and the non-text formats leave this part out.
  2. Prints the commands, each with its description, under headings such as auth, env and server.

--short only matters with --format: it leaves each command's arguments and options out of the JSON, XML or Markdown.

After it finishes

Take a name from the list to grim help for its arguments and options.