holm/nushell
1
1
Fork 0
forked from extern/nushell
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update alias docs (#2925)

Browse Source
This commit is contained in:
Leonhard Kipp 2021-01-13 02:46:15 +01:00 committed by GitHub
parent 4f2ae34df9
commit 63a62e19f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/commands/alias.md
View File

@ -1,18 +1,14 @@
# alias
This command allows you to define shortcuts for other common commands. By default, they only apply to the current session. To persist them, add `--save`.
This command allows you to define shortcuts for other common commands. By default, they only apply to the current session. To persist them, add them to your config.
Syntax: `alias {flags} <name> = <body>`
Syntax: `alias <name> = <body>`
The command expects two parameters:
* The name of the alias
* The body of the alias
## Flags
* `-s`, `--save`: Save the alias to your config (see `config path` to edit them later)
## Examples
Define a custom `myecho` command as an alias:
@ -34,18 +30,3 @@ Usage:
flags:
-h, --help: Display this help message
```
## Persistent aliases
Aliases are most useful when they are persistent. For that, use the `--save` flag:
```shell
> alias --save myecho = echo
```
This will store the alias in your config, under the `startup` key. To edit the saved alias, run it again with the same name, or edit your config file directly. You can find the location of the file using `config path`.
For example, to edit your config file in `vi`, run:
```shell
> vi $(config path)
```