help

CLI reference

Description

Print the long-form documentation for CLI commands (the same text as esysrepo <cmd> --doc).

With no command name, help prints this page (the help command's own documentation). With one or more names, it looks up each command and prints its man-like documentation. Unknown names are reported as errors; other valid names in the same invocation are still printed.

To list available commands or see short option help for a command, use esysrepo / esysrepo <cmd> --help instead.

Usage

esysrepo help [COMMAND ...]

Options

help has no command-specific options. Common options such as --folder / -f still apply. Command names are positional arguments after help.

Examples

Show this documentation:

esysrepo help

Show documentation for init:

esysrepo help init

Show documentation for several commands:

esysrepo help init sync pin

Equivalent long-form documentation for a single command:

esysrepo init --doc