From 911414a190e2ffdf4593ffab54cb3a6413c4e55d Mon Sep 17 00:00:00 2001 From: Jonathan Turner Date: Sun, 1 Dec 2019 06:59:53 +1300 Subject: [PATCH] Update config.md --- docs/commands/config.md | 47 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/commands/config.md diff --git a/docs/commands/config.md b/docs/commands/config.md new file mode 100644 index 0000000000..cae8e43ef3 --- /dev/null +++ b/docs/commands/config.md @@ -0,0 +1,47 @@ +# config + +Configuration management. + +Syntax: `config {flags}` + +### Flags + + + --load + load the config from the path give + + --set + set a value in the config, eg) --set [key value] + + --set_into + sets a variable from values in the pipeline + + --get + get a value from the config + + --remove + remove a value from the config + + --clear + clear the config + + --path + return the path to the config file + +### Variables + +| Variable | Type | Description | +| ------------- | ------------- | ----- | +| path | table of strings | PATH to use to find binaries | +| env | row | the environment variables to pass to external commands | +| ctrlc_exit | boolean | whether or not to exit Nu after multiple ctrl-c presses | +| table_mode | "light" or other | enable lightweight or normal tables | +| edit_mode | "vi" or "emacs" | changes line editing to "vi" or "emacs" mode | + +## Examples + +```shell +> config --set [table_mode "light"] +``` + +A more detailed description on how to use this command to configure Nu shell can be found in the configuration chapter of [Nu Book](https://book.nushell.sh/en/configuration).