Entering Commands in the CLI

The GigaVUE‑OS provides several conventions that make it easy to identify available commands and enter them quickly:

Technique

Description

Context-Sensitive Help

The? symbol is the key to receiving help wherever you are in the CLI:

● Type ? by itself to see a list of all available commands.
● Word Help – Type a partial word with? mark immediately following the partially-typed word to see a list of all possible commands using the word entered so far.

For example, if you typed r? in Configure mode, the CLI would return the following possible commands based on what you have entered so far:

radius-server Configure RADIUS server settingsreload Reboot or shut down the systemreset Reset this system to its factory state

● Command Help – Type a command followed by a question mark to see all possible arguments for the command as entered. If the node returns <cr>, that means the command can be entered as-is.

For example, if you entered gigastream ?, you would see alias. You can build your way through the entire command tree by entering ? after each new argument. For example, after entering gigastream alias myalias ?, you would see the next valid argument – port-list.

Note:  Typing ? accesses the help system immediately – you do not need to press <Enter>.

Partial Command Entry

For all GigaVUE H Series commands and arguments, you only need to enter enough characters to distinguish the command from all other available commands. So, for example, you do not have to enter the full command debug – there is only one command starting with the letter d, so you only have to enter d.

Command Completion

If you have partially typed a command, you can press Tab and the CLI will attempt to complete the command for you based on what has been entered so far.

Use the command completion feature together with partial command entry – you can press Tab while entering a command to see a list of all available commands matching what you have entered so far. For example, you can press p<Tab> and the node will return:

ping ping6 port port-group port-pair ptp

Based on this information, you know that you only need to enter pt to distinguish the ptp command from the other commands beginning with the letter p.