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.The
av
tool can be installed in a few ways, depending on your operating system and package manager preferences.Then, install
av
using the Homebrew tap.brew install aviator-co/tap/av
Download the latest
av
executable from the GitHub releases page on the av
repository. Extract the archive and add the executable to your PATH
.The
av
tool uses a GitHub personal access token (PAT) to authenticate with GitHub on your behalf. This is required to create and inspect PRs (e.g., when using the av pr create
command). The generated token should have the repo
scope (all other scopes can be left un-checked).
Required permissions for the GitHub personal access token that you will use with av
Add the GitHub token to your
av
config file (make sure to create the ~/.av
directory first):~/.av/config.yaml
github:
# Replace this value with the token you created in the step above
token: "ghp_abcdefghijklmnop"
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
Run the following command to upgrade
av
if it was installed with Homebrew.brew upgrade av
Follow the installation instructions above and overwrite the previous
av
binary with the newly downloaded binary.Last modified 8d ago