> For the complete documentation index, see [llms.txt](https://docs.aviator.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aviator.co/aviator-cli/how-to-guides/rename-a-branch.md).

# How to Rename a Branch in CLI

Branches created using `av branch` should only be renamed with `av branch` as well. `av` needs to update internal tracking metadata that defines the order of branches within a stack.

Simply use the `--rename` or `-m` flag.

```sh
aviator-co/av ‹original-branch-name*›$ av branch -m my-new-branch
aviator-co/av ‹my-new-branch*›$
```

If you have already created a pull request via `av pr`, `av` will not rename the branch without the `--force` flag.

```
aviator-co/av ‹test-pr*›$ av pr
Creating pull request for branch test-pr:
  - pushing to origin/test-pr
  - created pull request https://github.com/aviator-co/av/pull/175
aviator-co/av ‹test-pr*›$ av branch -m renamed-pr
Cannot rename branch test-pr: pull request #175 would be orphaned.
  - Use --force to override this check.
exit status 127
```

`av` cannot update the remote branch, but you can still force update your local branch name. The remote counterpart will still keep its old name.

```
aviator-co/av ‹test-pr*›$ av pr
Creating pull request for branch test-pr:
  - pushing to origin/test-pr
  - created pull request https://github.com/aviator-co/av/pull/175
aviator-co/av ‹test-pr*›$ av branch --force -m renamed-pr
aviator-co/av ‹renamed-pr*›$
```

{% hint style="info" %}
Note: Force updating the branch name requires closing the corresponding pull request and opening a new one using `av pr`. This will ensure that `av` can recognize the stack properly.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.aviator.co/aviator-cli/how-to-guides/rename-a-branch.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
