mirror of
https://github.com/kernelkit/infix.git
synced 2026-07-29 12:13:01 +02:00
Joachim WibergandTobias Waldekranz
9766bbbed5
Also, add a new `quick.md` that pops up when the user types `help`. Very quick intro to get started. Useful when we add a factory-default motd: "Welcome to the CLI, type 'help' for a quick overview." Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
# Quick Overview
|
|
|
|
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 keybindings` | Lists keybindings and other helpful tricks |
|
|
| `help tutorial` | The CLI User Guide |
|
|
|
|
|