2019-11-30 17:59:53 +00:00
# config
Configuration management.
Syntax: `config {flags}`
2020-06-23 18:21:47 +00:00
## Flags
2019-11-30 17:59:53 +00:00
2020-07-22 21:42:04 +00:00
load < file path shape >
2019-11-30 17:59:53 +00:00
load the config from the path give
2020-07-22 21:42:04 +00:00
set < any shape >
set a value in the config, eg) set variable value
2019-11-30 17:59:53 +00:00
2020-07-22 21:42:04 +00:00
set_into < member shape >
2019-11-30 17:59:53 +00:00
sets a variable from values in the pipeline
2020-07-22 21:42:04 +00:00
get < any shape >
2019-11-30 17:59:53 +00:00
get a value from the config
2020-07-22 21:42:04 +00:00
remove < any shape >
2019-11-30 17:59:53 +00:00
remove a value from the config
2020-07-22 21:42:04 +00:00
clear
2019-11-30 17:59:53 +00:00
clear the config
2020-07-22 21:42:04 +00:00
path
2019-11-30 17:59:53 +00:00
return the path to the config file
2020-06-23 18:21:47 +00:00
## Variables
2019-11-30 17:59:53 +00:00
2020-05-30 18:31:34 +00:00
| 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 |
| key_timeout | integer (milliseconds) | vi: the delay to wait for a longer key sequence after ESC |
| history_size | integer | maximum entries that will be stored in history (100,000 default) |
| completion_mode | "circular" or "list" | changes completion type to "circular" (default) or "list" mode |
| complete_from_path | boolean | whether or not to complete names of binaries on PATH (default true) |
| rm_always_trash | boolean | whether or not to always use system trash when no flags are given to `rm` |
2020-05-28 20:46:27 +00:00
| pivot_mode | "auto" or "always" or "never" | "auto" will only pivot single row tables if the output is greater than the terminal width. "always" will always pivot single row tables. "never" will never pivot single row tables. |
2020-05-30 18:31:34 +00:00
| plugin_dirs | table of strings | additional directories to search for plugins during startup |
2019-11-30 17:59:53 +00:00
## Examples
```shell
2020-07-22 21:42:04 +00:00
> config set table_mode "light"
2019-11-30 17:59:53 +00:00
```
2019-12-15 12:56:26 +00:00
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://www.nushell.sh/book/en/configuration.html ).
