From 7828636dd7d52edf946ba0ca93d5f4b359945f9c Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Tue, 2 Apr 2024 11:51:34 +0200 Subject: [PATCH] doc: when logging in you now land in UNIX shell by default Signed-off-by: Joachim Wiberg --- doc/cli/introduction.md | 10 ++++++---- doc/introduction.md | 20 +++++++++++++++----- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/doc/cli/introduction.md b/doc/cli/introduction.md index 5945f878..b05b768e 100644 --- a/doc/cli/introduction.md +++ b/doc/cli/introduction.md @@ -12,10 +12,12 @@ short guide intends to help you with that. ## Key Concepts The two modes in the CLI are the admin-exec and the configure context. -When logging in to the system, be it from console or SSH, you land in -admin-exec. Here you can inspect the system status and do operations -to debug networking issues, e.g. ping. You can also enter configure -context by typing: `configure` + +When logging in to the system, be it from console or SSH, you first have +a stopover in a UNIX shell, usually Bash. Type `cli` to enter the CLI +and finally land in admin-exec. Here you can inspect system status and +do operations to debug networking issues, e.g. ping. You can also enter +configure context by typing: `configure` The system has several datastores (or files): diff --git a/doc/introduction.md b/doc/introduction.md index 1b6743e3..e54f0954 100644 --- a/doc/introduction.md +++ b/doc/introduction.md @@ -21,11 +21,21 @@ is very useful to know how to navigate and use the CLI. ## Key Concepts The two modes in the CLI are the admin-exec and the configure context. -When logging in to the system, from the console port or SSH, you land in -admin-exec. Here you can inspect the system status and do operations to -debug networking issues, e.g. ping. You can also enter configure -context by typing: `configure` followed by commands to `set`, `edit`, -apply changes using `leave`, or `abort` and return to admin-exec. + +However, when logging in to the system, from the console port or SSH, +you land in a standard UNIX shell, Bash. This is for advanced users +and remote scripting purposes (production equipment). To enter the +CLI type: + + admin@example:~$ cli + admin@example:/> + +The prompt, constructed from your username and the device's hostname, +changes slightly. You are now in the admin-exec context of the CLI. +Here you can inspect system status and do operations to debug networking +issues, e.g. ping. You can also enter configure context by typing: +`configure` followed by commands to `set`, `edit`, apply changes using +`leave`, or `abort` and return to admin-exec. > The [CLI Introduction](cli/introduction.md) can be useful to skim > through at this point.