mirror of
https://github.com/kernelkit/infix.git
synced 2026-07-28 03:33:01 +02:00
Joachim Wiberg
5a339e46cb
Files in doc/cli/*.md are used in and displayed as help text in the CLI admin-exec level. So we cannot use standard admonitions (yet) since the terminal markdown converter (lowdown) doesn't support the syntax. Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# CLI Quickstart Guide
|
|
|
|
The question mark `?` key along with the `Tab` key are your best friends
|
|
in the command line interface. They provide context help and completion
|
|
of commands you input. See the table below for a handful of examples.
|
|
|
|
| **Command** | **Description** |
|
|
|---------------------|----------------------------------------------------|
|
|
| `help` | Overview of topics/settings in the current context |
|
|
| `?` | Lists commands + brief help in the current context |
|
|
| `<Tab>` | Lists commands available in the current context |
|
|
| `partial<Tab>` | Completes a partial command name |
|
|
| `command <Tab>` | Lists keywords/arguments associated with a command |
|
|
| `command keyword ?` | Lists arguments associated with a keyword + help |
|
|
|
|
Explore the following topics for more information. Note, the
|
|
keybindings are really useful to learn!
|
|
|
|
| **Command** | **Description** |
|
|
|---------------------|----------------------------------------------------|
|
|
| `help introduction` | An introduction to the CLI |
|
|
| `help configure` | How to use configure context |
|
|
| `help text-editor` | Help with the built-in text-editor command |
|
|
| `help keybindings` | Lists available keybindings & other helpful tricks |
|
|
|
|
----
|
|
|
|
> In `configure` context the `help setting` command shows the YANG
|
|
> description text for each node and container. To reach the admin
|
|
> exec help from configure context, e.g., `do help text-editor`
|
|
|
|
----
|