GitButler ⧓

Commands
>_

but reword

Edit the commit message of the specified commit.

You can easily change the commit message of any of your commits by running but reword <commit-id> and providing a new message in the editor.

This will recreate the commit with the new message and then rebase any dependent commits on top of it.

You can also use but reword <branch-id> to rename the branch.

Usage: but reword <TARGET> [OPTIONS]

Arguments

  • <TARGET> — Commit ID to edit the message for, or branch ID to rename (required)

Options

  • -m, --message <MESSAGE> — The new commit message or branch name. If not provided, opens an editor
  • -f, --fix-formatting — Format the existing commit message to 72-char line wrapping without opening an editor
  • --diff — Always show diff inside the editor.

By default the diff will be shown unless it's large. The diff will always be shown if --diff is passed, regardless of the size of the diff. (default: false)

  • --no-diff — Never show the diff inside the editor (default: false)
  • --allow-merged — Allow targeting branches and commits that are already merged upstream.

By default, mutations refuse to touch history that has landed in the target branch, since the results tend to conflict on the next but pull.

Last updated on

On this page

Edit on GitHubGive us feedback