This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Shell 4.0.3!

Help

Running a shell application often implies that the user is in a graphically limited environment. This is why it is important that the shell commands are correctly self-documented, and this is where the help command comes in.

Typing help + ENTER lists all the commands known to the shell and a short description of what they do, similar to the following:

my-shell:>help
AVAILABLE COMMANDS

Built-In Commands
       clear: Clear the terminal screen
	   help: Show help about available commands
       version: Show version info

Typing help <command>, <command> --help or <command> -h shows the detailed help of a given command: what it does, the parameters it accepts, their type and whether they are mandatory or not:

my-shell:>help version
NAME
	version - Show version info

DESCRIPTION
	This command displays the version of Spring Shell, as well as build and git information if available.

SYNOPSIS
	version --help

OPTIONS
	--help or -h
	help for version
	[Optional]