Installation

The Aviator command line tool (invoked as av) can be used to streamline and automate common tasks within your Git and GitHub workflows. Currently, the tool is used primarily to manage Stacked PRs.

First-time setup

1. Download the command line tool

The av tool can be installed in a few ways, depending on your operating system and package manager preferences.

Homebrew (macOS)

First, if not already done, install Homebrew.

Then, install av using the Homebrew tap.

brew install aviator-co/tap/av

Debian / Ubuntu

Download the .deb file from the releases page.

apt install ./av_$VERSION_linux_$ARCH.deb

RPM-based systems

Download the .rpm file from the releases page.

rpm -i ./av_$VERSION_linux_$ARCH.rpm

Arch Linux (AUR)

Published as av-cli-bin in AUR.

yay av-cli

Download executable (advanced, all operating systems)

Download the latest av executable from the GitHub releases page on the av repository. Extract the archive and add the executable to your PATH.

2. Connect av to GitHub

av CLI interacts with GitHub to fetch and push branches as well as create PRs. There are two ways to to authenticate with GitHub:

• GitHub CLI - The av CLI can automatically use GitHub CLI credential if it's available. Simply install the GitHub CLI and run gh auth login

• Personal access token - Alternatively create a Personal Access Token to authenticate with the CLI. See Create an Access Token.

3. Initialize your repository

Finally, in the repo where you want to use av, make sure to initialize the repository. From within your git repository, run the following command:

av init

Upgrade

Homebrew

Run the following command to upgrade av if it was installed with Homebrew.

brew upgrade av

Download executable

For other platforms, follow the installation instructions above and overwrite the previous av binary with the newly downloaded binary.