GitButler ⧓

GuidesCLI Tutorial

Working with AI

Use AI-backed CLI options and set up GitButler for coding agents.

Use --ai when you want the CLI to generate text for a single command. Use but agent setup when you want a coding agent to use GitButler's version-control workflow.

--ai options

Supported commands can take --ai to generate text from your current changes.

but commit --ai

Use but commit --ai to generate a commit message from the changes you are committing.

This commits the selected work with the generated message. You can edit the message afterward with but reword <commit>.

but squash --ai

Use but squash --ai to generate a combined commit message when squashing commits.

More commands will gain --ai support over time.

but agent setup

Run the setup wizard from the repository where your coding agent will work:

but agent setup

The wizard can install the GitButler skill, save workflow preferences in supported agent instruction files, and run but setup for the repository when GitButler needs workspace mode.

Use but skill install when you only want to install or update the skill files without writing workflow instructions.

To update an existing install without going through the prompts, run:

but skill install --detect

We keep these templates up to date, so update the skill after updating GitButler.

Agent workflow docs

For the full workflow:

Last updated on

On this page

Edit on GitHubGive us feedback