Skip to main content

Alias

Specify the same alias cross shell.

Syntaxโ€‹

alias:
- name: a
value: aliae
- name: hello-world
value: echo "hello world"
type: function
- name: sync
value: "!git fetch origin; git rebase origin/main"
type: git

Aliasโ€‹

NameTypeDescription
namestringthe alias name
valuestringthe command(s) you want to execute, supports templating
typestring
  • command: a regular alias, value is a one-liner (default)
  • function: a code block to be placed inside a function
  • git: a git alias definition
ifstringgolang template conditional statement, see if

Shell specific configurationโ€‹

NameTypeDescription
descriptionstringspecifies a description of the alias
forcebooleanuse the force parameter to change or delete an alias that has the Option parameter set to ReadOnly. The Force parameter cannot change or delete an alias with the option parameter set to Constant
optionstringsee the PowerShell documentation
scopestringsee the PowerShell documentation