add documentation for save, config

This commit is contained in:
Sebastian Jung
2019-11-29 18:15:51 +01:00
parent c77059f891
commit fbb65cde44
3 changed files with 72 additions and 1 deletions

28
docs/commands/save.md Normal file
View File

@ -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
```