From 94d81445eb66f782f91142c2dce9a03e89c2f4e0 Mon Sep 17 00:00:00 2001 From: Yahsin Huang Date: Tue, 1 Oct 2019 23:20:58 +0800 Subject: [PATCH] Add document for help --- docs/commands/help.md | 47 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/commands/help.md diff --git a/docs/commands/help.md b/docs/commands/help.md new file mode 100644 index 0000000000..a232910c72 --- /dev/null +++ b/docs/commands/help.md @@ -0,0 +1,47 @@ +# help + +Use `help` for more information on a command. +Use `help commands` to list all availble commands. +Use `help ` to display help about a particular command. + +## Examples + +```shell +> help +Welcome to Nushell. + +Here are some tips to help you get started. + * help commands - list all available commands + * help - display help about a particular command + +You can also learn more at https://book.nushell.sh +``` + +```shell +> help commands +━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + # │ name │ description +────┼──────────────┼──────────────────────────────────────────────────────────────────────────────────────── + 0 │ add │ Add a new field to the table. + 1 │ autoview │ View the contents of the pipeline as a table or list. + 2 │ cd │ Change to a new path. + 3 │ config │ Configuration management. + 4 │ cp │ Copy files. + 5 │ date │ Get the current datetime. +... + 70 │ trim │ Trim leading and following whitespace from text data. + 71 │ version │ Display Nu version + 72 │ where │ Filter table to match the condition. + 73 │ which │ Finds a program file. +━━━━┷━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +``` + +```shell +> help cd +Change to a new path. + +Usage: + > cd (directory) +``` + +