Get help from the CLI
How to get help directly from the CLI, to check available commands, completions, syntax and more.
Display a list of the available shell commands
At the command prompt, type
help.The CLI will display a list of the available system shell commands.
user@system:~$ help
GNU bash, version 5.1.4(1)-release (x86_64-pc-linux-gnu)
These shell commands are defined internally. Type `help' to see this list.
Type `help name' to find out more about the function `name'.
Use `info bash' to find out more about the shell in general.
Use `man -k' or `info' to find out more about commands not in this list.
A star (*) next to a name means that the command is disabled.
job_spec [&]
(( expression ))
. filename [arguments]
:
[ arg... ]
[[ expression ]]
alias [-p] [name[=value] ... ]
bg [job_spec ...]
bind [-lpsvPSVX] [-m keymap] [-f filename] [-q name] [-u name] [-r keyseq] [-x keys>
break [n]
builtin [shell-builtin [arg ...]]
caller [expr]
case WORD in [PATTERN [| PATTERN]...) COMMANDS ;;]... esac
cd [-L|[-P [-e]] [-@]] [dir]Display help for a specific shell command
At the command prompt, type
help <command>, where <command> is a specific shell command.The CLI will display help and usage guidelines for that command.
Display a list of all available Vyatta NOS commands
At the command prompt — in either mode — press the Tab key or the ? key.
user@system:~$ <Tab>user@system:~$ <?>The CLI will display a list of the available commands.
Possible completions:
add Add an object to a service
clear Clear system information
clone Clone an object
configure Enter configure mode
copy Copy an object
delete Delete an object
download Download an object
generate Generate an object
monitor Monitor system information
move Move an object
mtrace Show multicast path in ASCII graphic format
ping Send Internet Control Message Protocol (ICMP) echo request
poweroff Poweroff the system
reboot Reboot the system
release Release specified variable
rename Rename an object
renew Renew specified variable
request Request an operation be performed
reset Reset a service
restart Restart a service
set Set operational options
show Show system information
spawn Spawn a native Linux process
ssh Start a remote Secure Shell (SSH) connection.
start Start a service
telnet Telnet to a node
traceroute Track network path to node
twping Calculate stats using Two-Way Active Measurement Protocol (TWAMP)
update Update data for a service
upgrade Upgrade data for a service
upload Download an object
user@system:~$Display available Vyatta NOS command completions
When you have typed the first part of a command string and you're not sure exactly what to type next, press the Tab key or the ? key.
The CLI will display a filtered list of available commands and completions that are appropriate to that context.