See every command
$ grim list server
You know there is a command for it and not what it is called. grim list prints the commands you work with in a project — about forty — with a one-line description each, grouped by namespace, and ends with how many it left out. Plain grim with no arguments does the same.
The rest are the advanced commands: server:*, infra:*, monorepo:*, docs:*, remote:*, migrate:*, hosts:*, error:test, release and tune — the ones for running servers, cloud infrastructure and the monorepo. They stay installed, documented and completable; --all lists them, and naming their namespace (grim list server) always shows that namespace in full.
Usage
$ grim list # the everyday commands, grouped
$ grim list --all # every command, advanced ones included
$ grim list server # only server:*, including server:dev:*
$ grim list --raw # names and descriptions, no decoration
$ grim list --format=json # for a scriptIt runs from anywhere and needs no project. Every command listed answers grim <command> --help with the text of its own page, so the next step from here needs no browser.
Arguments and options
List commands
Usage
grim list [--raw] [--format FORMAT] [--short] [-a|--all] [--] [<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 |
-a, --all |
Include the advanced commands (servers, infra, monorepo, docs) |
What it actually does
- Prints the grim version and the options every command shares.
--rawand the non-text formats leave this part out. - Prints the commands, each with its description, under headings such as
auth,envandserver.
--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.
Related spells
grim help
Read a command's usage
Print the description, usage, arguments and options of one command, in the terminal.
grim completion
Tab-complete every spell
Print the shell script that makes Tab complete grim's commands and options in bash, zsh and fish.
grim doctor
Check your circle
Check every tool grim expects on this machine, and the project you are standing in, and say what to do about what is missing.