help

help is the built-in command that prints the short usage guide of the CLI to the screen. It has no subcommand, field or option.

The guide is also shown when the session opens

The guide is printed once by itself in every session right after the user logs in. The help command shows the same output again whenever it is wanted.

Command Summary

TR7 WEB-CLI · help

admin@TR7LBWAF01> help

╔════════════════════════════════════════════════════════════╗

║ TR7 CLI HELP ║

╚════════════════════════════════════════════════════════════╝

OVERVIEW · COMMAND TYPES · PIPE OPERATIONS · …

admin@TR7LBWAF01>  

The Sections in the Output

Section	Its content
Overview	What the CLI is
Command types	The three command branches: the API commands, the system commands and the pipe commands
Pipe operations	The chained writing, the frequently used filters and an example
Output formatting	The --output formats and --filter
System commands	A short list of the frequently used sys-cmd tools
File operations	The commands for writing the output to a file and managing the saved files
Keyboard shortcuts	The keyboard shortcuts
Special options	The common options such as --info
Built-in commands	help and history
Tips	Three short suggestions
First access instructions	It appears only on devices on which the management access has not been configured yet

The lists are abbreviated

The filter, tool and format lists in the guide are a summary; for the full lists, the Pipe Commands, System Commands and API Commands pages should be consulted.

The Keyboard Shortcuts

The shortcuts that the guide lists:

Shortcut	Its function
Tab	Completes the command and the field
↑ ↓	Navigates in the history and among the options
Ctrl + R	Searches in the command history; when it is pressed again it moves to an older match
→ or End	Accepts the history suggestion that appears in grey at the end of the line
Enter	Runs the command or confirms the selection
Ctrl + C	Interrupts the running operation and clears the line

For the Ctrl + D shortcut that closes the session, the exit page can be consulted.

The First Access Steps

If the management interface access has not been configured on the device yet, a section of three steps is added to the end of the guide: logging in with admin:admin, running the settings access init command, and defining an address and a port for the management interface. After the access is configured, this section does not appear.

Things to Know

• Help does not require authorization. Every user who has a session can run it.
• The language of the guide follows the user. The text is printed in Turkish or in English according to the language the user selected in the panel; there is no field on the command line that selects the language.
• The command descriptions can also be read separately. In order to see what a command does without running it, --info is added to its end; for the list of the fields at the point where one is, ? is written at the end of the line and Enter is pressed.