GitButler ⧓

Commands
>_

Commands Overview

Your fast index to all of the available commands

Command reference

Basics

  • setup: Set up a Git repository to be managed by GitButler
  • teardown: Exit GitButler mode and return to normal Git

Inspection

  • status: Show the project workspace state
  • diff: Show a diff for the workspace or a CLI ID
  • show: Show information about a commit or branch

Branching and committing

  • commit: Commit changes to a stack
  • stage: Stage changes to a branch
  • branch: Commands for managing branches
  • merge: Local branch merging
  • discard: Discard uncommitted changes
  • resolve: Resolve conflicts in a commit
  • unapply: Unapply a branch from the workspace
  • apply: Apply a branch to the workspace
  • clean: Remove empty branches from the workspace
  • pick: Cherry-pick a commit from an unapplied branch

Rules

  • mark: Create or remove a rule for auto-assigning or auto-committing
  • unmark: Remove all marks from the workspace

Server interactions

  • push: Push changes in a branch to remote
  • pull: Pull upstream changes and update your branches
  • pr: Create and manage reviews on GitHub, GitLab, and other forges

Editing commits

  • rub: Combine two entities to amend, squash, move, or unassign work
  • absorb: Amend changes into the commits where they belong
  • reword: Edit a commit message or branch name
  • uncommit: Move commit changes back to unassigned work
  • amend: Amend a file change into a commit
  • squash: Squash commits together
  • move: Move a commit or branch to a different location

Operations log

  • oplog: View and manage operation history
  • undo: Undo the last operation
  • redo: Redo the last undo

Helper commands

  • gui: Open the GitButler GUI for the current project
  • tui: Show an interactive TUI
  • update: Manage GitButler CLI and app updates
  • alias: Manage command aliases
  • config: View and manage GitButler configuration
  • skill: Manage AI agent skills for GitButler

Last updated on

On this page

Edit on GitHubGive us feedback