extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-18 14:00:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

update config documentation (#2178)

Browse Source 
* update config documentation

* update config syntax

* update config syntax

* Update alias.md

Co-authored-by: Jonathan Turner <jonathandturner@users.noreply.github.com>
This commit is contained in:
morrme
2020-07-22 16:42:04 -05:00
committed by GitHub
parent 6b4634b293
commit 5d17b72852
5 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/commands/alias.md
View File

@@ -12,7 +12,7 @@ The command expects three parameters:
## Flags
* `-s`, `--save`: Save the alias to your config (see `config --path` to edit them later)
* `-s`, `--save`: Save the alias to your config (see `config path` to edit them later)
## Examples
@@ -54,7 +54,7 @@ flags:
Aliases are most useful when they are persistent. For that, add them to your startup config:
```shell
> config --set [startup ["alias myecho [msg] { echo $msg }"]]
> config set startup ["alias myecho [msg] { echo $msg }"]
```
This is fine for the first alias, but since it overwrites the startup config, you need a different approach for additional aliases.
@@ -62,7 +62,7 @@ This is fine for the first alias, but since it overwrites the startup config, yo
To add a 2nd alias:
```shell
> config --get startup | append "alias s [] { git status -sb }" | config --set_into startup
> config get startup | append "alias s [] { git status -sb }" | config set_into startup
```
This first reads the `startup` config (a table of strings), then appends another alias, then sets the `startup` config with the output of the pipeline.
@@ -70,7 +70,7 @@ This first reads the `startup` config (a table of strings), then appends another
To make this process easier, you could define another alias:
```shell
> alias addalias [alias-string] { config --get startup | append $alias-string | config --set_into startup }
> alias addalias [alias-string] { config get startup | append $alias-string | config set_into startup }
```
Then use that to add more aliases: