avr help

Shows avar’s help, or one command’s. Help never runs the command it describes.

  1. Help
  2. Examples
  3. What it does
  4. Exit status
  5. Errors

Help

This is exactly what avr help help or avr help --help prints.

Usage:
  avr help [command]

Show avr's help, or help for one public management command.

Examples

avr help               # avar's help: the grammar, every command, every flag
avr help reset         # one command's help
avr reset --help       # the same; reset does not run
avr --help             # the same as avr help
avr -- help            # a program called help inside Linux

What it does

avr help, avr --help and avr -h print avar’s general help. It is the text on the avr page.

avr help <command> prints one command’s usage, description and flags, the text at the top of each command page. So does --help or -h anywhere after a command’s name: avr destroy --all --help shows help for avr destroy and destroys nothing.

Help touches nothing: no state, no backend, no environment. It works before Lima or WSL is installed.

Exit status

Status When
0 Help was printed
2 The command name is not an avar command, or more than one name was given

Errors

avr: unknown command "<name>"; run `avr --help` to see avar's commands

Exit status 2.

avr: `avr help` takes at most one command name, got ["<name>" "<name>"]

Exit status 2.