https://github.com/cpendery/kaldo

cross shell aliases
https://github.com/cpendery/kaldo

alias bash cli fish kaldo powershell zsh

Last synced: 2 months ago
JSON representation

cross shell aliases

• Host: GitHub
• URL: https://github.com/cpendery/kaldo
• Owner: cpendery
• Created: 2024-03-11T05:46:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-15T21:53:48.000Z (9 months ago)
• Last Synced: 2024-10-06T13:26:45.470Z (3 months ago)
• Topics: alias, bash, cli, fish, kaldo, powershell, zsh
• Language: Shell
• Homepage:
• Size: 32.2 KB
• Stars: 59
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# kaldo

`kaldo` provides the ability to share aliases across all your shells. It supports Windows, Linux, & macOS along with `bash`, `zsh`, `fish`, `pwsh`, and `powershell` (Windows Powershell).

## Installation

### Windows

```shell

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

iwr -useb https://raw.githubusercontent.com/cpendery/kaldo/main/install.ps1 | iex

```

### macOS / Linux

```

curl -sSfL https://raw.githubusercontent.com/cpendery/kaldo/main/install.sh | sh -s

```

### Initialize Shell Plugin

_ignore this section if you used the install script_

If installed manually, you need to initialize the shell plugin for each shell you want to share aliases with. After using your respective shell commands below, restart your shell to get shared aliases.

```shell

# bash

echo $(kaldo init bash) >> ~/.bashrc

# zsh

echo $(kaldo init zsh) >> ~/.zshrc

# fish

echo $(kaldo init fish) >> ~/.config/fish/config.fish

# pwsh

echo $(kaldo init pwsh) >> $profile

# powershell

echo $(kaldo init powershell) >> $profile

```

## Configure Aliases

All aliases are stored inside your `~/.kaldorc` toml file. Below is an example of how to define shell specific and cross shell aliases. The following tables result in custom aliases while no table results in an alias for every shell.

- `bash`: aliases for the bash shell

- `zsh`: aliases for the zsh shell

- `fish`: aliases for the fish shell

- `powershell`: aliases for Windows Powershell

- `pwsh`: aliases for Powershell Core

There are also 2 custom group tables that help reduce duplication across similar shells.

- `sh`: aliases for `bash`, `zsh`, and `fish`

- `power`: aliases for `powershell` and `pwsh`

```toml

# .kaldorc

ek = 'echo "kaldo"' # when outside of a table, the alias is loaded for all your shells

[bash]

ek = 'echo "kaldo on bash"' # inside the bash table, this alias is only provided for bash and overrides your shared alias

```