Shell

bash

Add the following to ~/.bashrc (could be ~/.profile or ~/.bash_profile depending on your environment):

eval "$(aliae init bash)"

Once added, reload your profile for the changes to take effect.

exec bash

Or, when using ~/.profile.

. ~/.profile

cmd

The integration with cmd assumes you have [Clink][clink] installed. If you don't, you'll need to install it and enjoy all of its features. Follow the installation instructions and make sure you select autostart.

Integrating aliae with Clink is easy: create a new file called aliae.lua in your Clink scripts directory (run clink info inside cmd to find that file's location).

aliae.lua

load(io.popen('aliae init cmd'):read("*a"))()

Once added, restart cmd for the changes to take effect.

fish

Initialize aliae in ~/.config/fish/config.fish:

aliae init fish | source

Once added, reload your config for the changes to take effect.

exec fish

nu

caution

aliae requires Nushell v0.104.0 or higher.

Add the following line at the bottom of the Nushell config file ($nu.config-path):

aliae init nu

This writes the initialization script to Nushell's vendor autoload directory ($nu.data-dir | path join vendor autoload), which Nushell loads automatically.

Once added, restart Nushell for the changes to take effect.

info

To disable aliae, remove the line from the Nushell config file and delete aliae.nu from the vendor autoload directory.

powershell

Edit your PowerShell profile script, you can find its location under the $PROFILE variable in your preferred PowerShell version. For example, using notepad:

notepad $PROFILE

info

When the above command gives an error, make sure to create the profile first.

New-Item -Path $PROFILE -Type File -Force

In this scenario, it can also be that PowerShell blocks running local scripts. To solve that, set PowerShell to only require remote scripts to be signed using Set-ExecutionPolicy RemoteSigned, or [sign the profile][sign].

Then add the following line.

aliae init pwsh | Invoke-Expression

Once added, reload your profile for the changes to take effect.

. $PROFILE

tcsh

Add the following at the end of ~/.tcshrc:

eval `aliae init tcsh`

Once added, reload your profile for the changes to take effect.

exec tcsh

xonsh

Add the following line at the end of ~/.xonshrc:

execx($(aliae init xonsh))

Once added, reload your profile for the changes to take effect.

exec xonsh

zsh

Add the following to ~/.zshrc:

eval "$(aliae init zsh)"

Once added, reload your profile for the changes to take effect.

exec zsh