useGit API
    Preparing search index...

    Interface BranchOptions

    interface BranchOptions {
        "--abbrev"?: string;
        "--color"?: "always" | "auto" | "never";
        "--column"?: string;
        "--set-upstream-to"?: string;
        "--sort"?: string;
        flags?: (
            | "--force"
            | "--all"
            | "--show-current"
            | "--list"
            | "--remotes"
            | "--delete"
            | "-D"
            | "--move"
            | "-M"
            | "--copy"
            | "-C"
            | "--ignore-case"
            | "--omit-empty"
            | "--no-column"
            | "--quiet"
            | "--no-abbrev"
            | "--unset-upstream"
        )[];
    }
    Index

    Properties

    --abbrev? --color? --column? --set-upstream-to? --sort? flags?

    Properties

    Optional--abbrev

    "--abbrev"?: string

    Minimum abbreviation length for object names.

    Optional--color

    "--color"?: "always" | "auto" | "never"

    Color branches to highlight current, local, and remote-tracking branches.

    "always"

    Optional--column

    "--column"?: string

    Display branch listing in columns.

    Optional--set-upstream-to

    "--set-upstream-to"?: string

    Set upstream branch.

    Sets the upstream branch explicitly, typically in the form: remote/branch.

    "origin/main"

    Optional--sort

    "--sort"?: string

    Sort branch output by the specified key.

    flags?: (
        | "--force"
        | "--all"
        | "--show-current"
        | "--list"
        | "--remotes"
        | "--delete"
        | "-D"
        | "--move"
        | "-M"
        | "--copy"
        | "-C"
        | "--ignore-case"
        | "--omit-empty"
        | "--no-column"
        | "--quiet"
        | "--no-abbrev"
        | "--unset-upstream"
    )[]

    Branch operation flags.

    Some flags require branch names:

    • --delete, -D
    • --move, -M
    • --copy, -C

    Settings

    Member Visibility

    On This Page

    Properties