From 63a62e19f9cc29327a04818e0b2d9ed49c8c4c9b Mon Sep 17 00:00:00 2001 From: Leonhard Kipp Date: Wed, 13 Jan 2021 02:46:15 +0100 Subject: [PATCH] Update alias docs (#2925) --- docs/commands/alias.md | 23 ++--------------------- 1 file changed, 2 insertions(+), 21 deletions(-) diff --git a/docs/commands/alias.md b/docs/commands/alias.md index 28f2ab16d..f29fa88e7 100644 --- a/docs/commands/alias.md +++ b/docs/commands/alias.md @@ -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} = ` +Syntax: `alias = ` 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) -```