@spec branch_exists?(binary()) :: boolean()

Returns true if the given branch exists locally or remotely.

@spec checkout(map()) :: {:ok, map()} | {:error, any()}

Checks out the main_branch of a repository, stashing uncommitted changes first if necessary.

@spec create_branch(binary(), binary()) :: {:ok, binary()} | {:error, any()}

Creates a new branch.

@spec delete_branch(binary(), binary()) :: {:ok, binary()} | {:error, any()}

Deletes a branch.

@spec get_current_branch(binary()) :: {:ok, binary()} | {:error, binary()}

Returns the currently checked-out branch name.

@spec has_stash?(binary()) :: boolean()

Returns true if the repository has stash entries.

@spec list_local_branches(binary()) :: {:ok, [binary()]} | {:error, any()}

Returns the list of all local branches.

@spec stash_if_needed(binary()) ::
  {:ok, {:stashed, binary()} | :clean} | {:error, any()}

Stashes uncommitted changes if the working tree is dirty.

Returns {:ok, {:stashed, branch}}, {:ok, :clean}, or {:error, reason}.

@spec stash_pop(binary()) :: {:ok, binary()} | {:error, binary()}

Restores stashed changes.

@spec stash_push(
  binary(),
  keyword()
) :: {:ok, binary()} | {:error, binary()}

Pushes stash entries in a repository.

Options

• :message — stash description (default: "auto-stash")
• :include_untracked — include untracked files (default: true)