summaryrefslogtreecommitdiff
path: root/docs/ch02-cli.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ch02-cli.rst')
-rw-r--r--docs/ch02-cli.rst85
1 files changed, 85 insertions, 0 deletions
diff --git a/docs/ch02-cli.rst b/docs/ch02-cli.rst
new file mode 100644
index 00000000..7023c263
--- /dev/null
+++ b/docs/ch02-cli.rst
@@ -0,0 +1,85 @@
+Command-Line Interface
+======================
+
+The VyOS CLI comprises an **operational mode** and a **configuration mode**.
+
+Operational mode allows for commands to perform operational system tasks and
+view system and service status, while configuration mode allows for the
+modification of system configuration. The command tree page lists available
+commands and their functions.
+
+The CLI provides a built-in help system. In the CLI the **[?]** key may be used
+to display available commands. The **[tab]** key can be used to auto-complete
+commands and will present the help system upon a conflict or unknown value.
+
+For example typing `sh` followed by the **[tab]** key will complete to `show`.
+Pressing **[tab]** a second time will display the possible sub-commands of the
+`show` command.
+
+.. code-block:: sh
+
+ vyos@vyos:~$ s[tab]
+ set show
+ vyos@vyos:~$
+
+Example showing possible show commands:
+
+.. code-block:: sh
+
+ vyos@vyos:~$ show [tab]
+ Possible completions:
+ arp Show Address Resolution Protocol (ARP) information
+ bridge Show bridging information
+ cluster Show clustering information
+ configuration Show running configuration
+ conntrack Show conntrack entries in the conntrack table
+ conntrack-sync
+ Show connection syncing information
+ date Show system date and time
+ dhcp Show Dynamic Host Configuration Protocol (DHCP) information
+ dhcpv6 Show status related to DHCPv6
+ disk Show status of disk device
+ dns Show Domain Name Server (DNS) information
+ file Show files for a particular image
+ firewall Show firewall information
+ flow-accounting
+ Show flow accounting statistics
+ hardware Show system hardware details
+ history show command history
+ host Show host information
+ incoming Show ethernet input-policy information
+ : q
+ vyos@vyos:~$
+
+When the output of a command results in more lines than can be displayed on the
+terminal screen the output is paginated as indicated by a : prompt.
+
+When viewing in page mode the following commands are available:
+ * **[q]** key can be used to cancel output
+ * **[space]** will scroll down one page
+ * **[b]** will scroll back one page
+ * **[return]** will scroll down one line
+ * **[up-arrow]** and **[down-arrow]** will scroll up or down one line at a
+ time respectively
+ * **[left-arrow]** and **[right-arrow]** can be used to scroll left or right
+ in the event that the output has lines which exceed the terminal size.
+
+To enter configuration mode use the `configure` command:
+
+.. code-block:: sh
+
+ vyos@vyos:~$ configure
+ [edit]
+ vyos@vyos:~#
+
+Note that the prompt changes from `$` to `#`. To exit configuration mode, type
+`exit`.
+
+.. code-block:: sh
+
+ vyos@vyos:~# exit
+ exit
+ vyos@vyos:~$
+
+See the configuration section of this document for more information on
+configuration mode.