Installation

Install and connect your shell.

The fastest path is the release installer. It downloads the matching binary for your platform and installs it to ~/.local/bin by default. Interactive installs can also wire Aliaz into zsh, bash, fish, or multiple shells.

Release installer

One command for macOS and Linux.

This is the primary install path from the README. The script chooses the release asset for the current platform and installs the binary. When a terminal is available, it can ask which shells to configure.

install
$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | sh
$ aliaz --help
Options

Script shell setup, sync setup, version, or destination.

Configure shells

Set ALIAZ_INSTALL_SHELLS to one or more shell names, all, or skip.

$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | ALIAZ_INSTALL_SHELLS="zsh bash" sh
$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | ALIAZ_INSTALL_SHELLS=skip sh

Start sync setup

Use ALIAZ_INSTALL_SYNC with login or register. Non-interactive runs also need ALIAZ_SYNC_USERNAME.

$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | ALIAZ_INSTALL_SYNC=login ALIAZ_SYNC_USERNAME=ada sh

Install a version

Set ALIAZ_VERSION before the shell script.

$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | ALIAZ_VERSION=v0.1.0 sh

Change install dir

Use ALIAZ_INSTALL_DIR for another binary path.

$ curl -fsSL https://raw.githubusercontent.com/oshabana/aliaz/main/install.sh | ALIAZ_INSTALL_DIR=/usr/local/bin sh
Source

Build with Cargo when you want local development.

Install Rust if needed, then install Aliaz from the open-source GitHub repository checkout.

source build
$ cargo install --path .
$ cargo run -- --help
$ cargo run -- add gs "git status"
Verify

Confirm the binary is available.

If aliaz is not found, add the install directory to your PATH and open a new shell. If you skipped shell setup, run aliaz init zsh, aliaz init bash, or aliaz init fish.

verify
$ aliaz --help
Manage shell aliases from a local SQLite-backed source of truth