Sets up a GitButler project from a git repository in the current directory.

Sets up a GitButler project from a git repository in the current directory.

This command will:

• Add the repository to the global GitButler project registry
• Switch to the gitbutler/workspace branch (if not already on it)
• Set up a default target branch (the remote's HEAD)
• Add a gb-local remote if no push remote exists

If you have an existing Git repository and want to start using GitButler with it, you can run this command to set up the necessary configuration and data structures.

Examples

Initialize a new git repository and set up GitButler:

but setup --init

Usage: but setup [OPTIONS]

Options

• --init — Initialize a new git repository with an empty commit if one doesn't exist.

This is useful when running in non-interactive environments (like CI/CD) where you want to ensure a git repository exists before setting up GitButler.