useGit API
    Preparing search index...

    Interface CommitOptions

    interface CommitOptions {
        "--author"?: string;
        "--cleanup"?: "default" | "strip" | "whitespace" | "verbatim" | "scissors";
        "--date"?: string;
        "--file"?: string;
        "--fixup"?: string;
        "--gpg-sign"?: string | true;
        "--reuse-message"?: string;
        "--squash"?: string;
        "--template"?: string;
        "--untracked-files"?: "no" | "normal" | "all";
        flags?: (
            | "--all"
            | "--quiet"
            | "--amend"
            | "--no-verify"
            | "--signoff"
            | "--no-edit"
            | "--patch"
            | "--allow-empty"
            | "--allow-empty-message"
            | "--status"
            | "--no-status"
            | "--reset-author"
        )[];
    }
    Index

    Properties

    --author? --cleanup? --date? --file? --fixup? --gpg-sign? --reuse-message? --squash? --template? --untracked-files? flags?

    Properties

    Optional--author

    "--author"?: string

    Override the commit author.

    Format: "name "

    Optional--cleanup

    "--cleanup"?: "default" | "strip" | "whitespace" | "verbatim" | "scissors"

    Optional--date

    "--date"?: string

    Override the author date used in the commit.

    - "2024-01-01"
    - "yesterday"
    - "RFC 2822 / ISO 8601"

    Optional--file

    "--file"?: string

    Take commit message from file or stdin ("-").

    Optional--fixup

    "--fixup"?: string

    Optional--gpg-sign

    "--gpg-sign"?: string | true

    GPG-sign the commit.

    - true  → --gpg-sign
    - string → --gpg-sign=<keyid>

    Optional--reuse-message

    "--reuse-message"?: string

    Optional--squash

    "--squash"?: string

    Optional--template

    "--template"?: string

    Use a commit message template file.

    Optional--untracked-files

    "--untracked-files"?: "no" | "normal" | "all"
    "all"
    flags?: (
        | "--all"
        | "--quiet"
        | "--amend"
        | "--no-verify"
        | "--signoff"
        | "--no-edit"
        | "--patch"
        | "--allow-empty"
        | "--allow-empty-message"
        | "--status"
        | "--no-status"
        | "--reset-author"
    )[]

    Settings

    Member Visibility

    On This Page

    Properties