diff --git a/docs/commands/config.md b/docs/commands/config.md new file mode 100644 index 0000000000..f5605e23a8 --- /dev/null +++ b/docs/commands/config.md @@ -0,0 +1,43 @@ +# 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 + +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/). \ No newline at end of file diff --git a/docs/commands/from-yaml.md b/docs/commands/from-yaml.md index 1c81c7dc94..90a2dd90ac 100644 --- a/docs/commands/from-yaml.md +++ b/docs/commands/from-yaml.md @@ -1,6 +1,6 @@ # from-yaml -Parse text as `.yaml/.yml` and create table. +Parse text as `.yaml/.yml` and create table. Use this when nushell cannot dertermine the input file extension. Syntax: `from-yaml` diff --git a/docs/commands/save.md b/docs/commands/save.md new file mode 100644 index 0000000000..2ff76f5370 --- /dev/null +++ b/docs/commands/save.md @@ -0,0 +1,28 @@ +# save + +This command saves the contents of the pipeline to a file. Use this in combination with the `to-json`, `to-csv`, ... commands to save the contents in the specified format. + +Syntax: `save (path) {flags}` + +### Parameters: + +* `(path)` the path to save contents to + +### Flags + + --raw + treat values as-is rather than auto-converting based on file extension + +## Example + +You can save the name of files in a directory like this: + +```shell +> ls | where type == File | pick name | save +``` + +Or you can format it in supported formats using one of the `to-*` commands: + +```shell +> ls | where type == File | pick name | to-csv | save +``` \ No newline at end of file