# Quickstart for Stacked PRs CLI This page explains how to use Aviator CLI to drive day-to-day development. ## Before you begin 1. [Install Aviator CLI](/aviator-cli/installation.md) 2. [Set up GitHub Personal Access Token](/aviator-cli/how-to-guides/create-a-user-access-token.md#github-personal-access-token) 3. Clone your repository locally ## Initialize your repository with Aviator CLI Run `av init` inside your repository. You need to do this only once per your local clone. ``` $ av init Successfully initialized repository for use with av! ``` ## Create a topic branch You can create a branch with `av branch BRANCH_NAME` from `main`, or you can also use `av commit --branch-name BRANCH_NAME` to both create a branch and commit your changes to the new branch. ``` $ git switch main Already on 'main' Your branch is up to date with 'origin/main'. $ echo "Some changes" > testfile $ av commit -A -m "Add a new file" --branch-name mytopic [mytopic b420345] Add a new file 1 file changed, 1 insertion(+) create mode 100644 testfile ``` The topic branch `mytopic` is intended to be merged to `main` later. If you want to use other branch as the merge destination, checkout that branch first. {% @mermaid/diagram content="gitGraph commit id: "1" commit id: "2" branch mytopic checkout mytopic commit id: "b420345"" %} ## Create a pull-request Create a pull-request with `av pr`. It shows an editor for the pull-request description. Every time you update your local branch, you can run this to update the pull-request. ``` $ av pr Creating pull request for branch mytopic: - pushing to origin/mytopic - created pull request https://github.com/yourname/yourrepo/pull/16 ``` ## Stack a new topic branch Create a new topic branch on top of the current topic branch with `av branch`. ``` $ av branch another_topic ``` You can see the stack with `av tree`. ``` $ av tree * another_topic (HEAD) │ No pull request │ * mytopic │ https://github.com/yourname/yourrepo/pull/16 │ * main ``` Add more changes to the branch. ``` $ echo "More changes" > newfile $ av commit -A -m "Add another file" [another_topic f60c4da] Add another file 1 file changed, 1 insertion(+) create mode 100644 newfile nothing to restack ``` {% @mermaid/diagram content="gitGraph commit id: "1" commit id: "2" branch mytopic checkout mytopic commit id: "b420345" branch another\_branch checkout another\_branch commit id: "f60c4da"" %} ## Create a second pull-request The second pull-request can be created with `av pr` now. ``` $ av pr Creating pull request for branch another_topic: - pushing to origin/another_topic - created pull request https://github.com/yourname/yourrepo/pull/17 ``` You can see the pull-request URLs with `av tree`. ``` $ av tree * another_topic (HEAD) │ https://github.com/yourname/yourrepo/pull/17 │ * mytopic │ https://github.com/yourname/yourrepo/pull/16 │ * main ``` The first pull-request is targeting the `main` branch. And the second pull-request is targeting the first pull-request branch. This will be updated once you merge the first pull-request. ## Merge and sync the pull-requests Let's merge the first pull-request now. We merge the first pull-request and keep the second pull-request open. {% @mermaid/diagram content="gitGraph commit id: "1" commit id: "2" branch mytopic checkout mytopic commit id: "b420345" branch another\_branch checkout another\_branch commit id: "f60c4da" checkout main merge mytopic" %} After this, we want to make the second one to be rebased on top of the newly updated `main` branch. To do this, we run `av sync`. ``` $ av sync ✓ GitHub fetch is done ✓ Restack is done * ✓ another_topic e808923 │ * main ba8eefe Confirming the push to GitHub Following branches do not need a push. mytopic: PR is already merged. Following branches need to be pushed. another_topic Remote: cb51296 Add another file 2024-06-25 13:01:45 -0700 -0700 (1 minute ago) Local: e808923 Add another file 2024-06-25 13:03:07 -0700 -0700 (10 seconds ago) PR: https://github.com/yourname/yourrepo/pull/17 Are you OK with pushing these branches to remote? ▸ Yes. Push the branches to GitHub. No. Do not push the branches to GitHub. ↑/k move up • ↓/j move down • space/enter select • ctrl+c cancel ``` It fetches the latest `main` from the remote, rebase the second branch on top of it. Choose to push to the remote. ``` $ av sync ✓ GitHub fetch is done ✓ Restack is done * ✓ another_topic e808923 │ * main ba8eefe ✓ Pushed to GitHub Following branches do not need a push. mytopic: PR is already merged. Following branches are pushed. another_topic Remote: cb51296 Add another file 2024-06-25 13:01:45 -0700 -0700 (2 minutes ago) Local: e808923 Add another file 2024-06-25 13:03:07 -0700 -0700 (1 minute ago) PR: https://github.com/yourname/yourrepo/pull/17 Confirming the deletion of merged branches Following merged branches can be deleted. mytopic: 6d19ed1f0019d0f59b65177ef7a4f358c278baec Are you OK with deleting these merged branches? ▸ Yes. Delete these merged branches. No. Do not delete the merged branches. ↑/k move up • ↓/j move down • space/enter select • ctrl+c cancel ``` Since the first branch is already merged, it asks you if you want to delete the local branch. Choose yes to delete the merged branch. If you run `av tree`, you can see that the second branch now has `main` as the parent. ``` $ av tree * another_topic │ https://github.com/yourname/yourrepo/pull/17 │ * main (HEAD) ``` ## What's next * [Review the How-to guides for common CLI commands](/aviator-cli/how-to-guides.md). * [Learn how to add Aviator CLI commands as a Git subcommand](/aviator-cli/how-to-guides/git-subcommand-aliasing.md) * [Learn how to adopt a branch created from Git command](/aviator-cli/how-to-guides/adopt-a-branch.md) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.aviator.co/aviator-cli/quickstart.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.