Packages

simple-git

4.1.0 · 16 Nov 2026MIT15.5M / weekRepositorynpmAtom feed

Your version

4.0.0

major25 Sep 2026Where it was published

4.1.0 is the newest release of 4.x.

In short

2 removed2 new1 fixed1 changed1 internal

  • Removed

    Removed previously available default export, now uses a consistently named simpleGit export.

  • Removed

    Removed legacy gitP export (change to using the main simpleGit export).

Security

1 advisory affects 4.0.0; 4.0.1 fixes them

Release note

Major Changes

  • Breaking

    Major upgrade to v4. In this version:

    • Removed previously available default export, now uses a consistently named simpleGit export.

    • Removed previously deprecated import simple-git/promise (change to using the main simple-git import).

    • Removed legacy gitP export (change to using the main simpleGit export).

    // v3 - previously supported imports
    import simpleGit from "simple-git";
    import { gitP } from "simple-git";
    import simpleGit from "simple-git/promise";
    const simpleGit = require("simple-git");
    
    // v4 - consolidates to a single supported import
    import { simpleGit } from "simple-git";
    const { simpleGit } = require("simple-git");
    • Prevents the use of abbreviated long-form git options:

    // v3 - allowed the use of unambiguous long-form options
    git.raw("clone", "--conf=user.name=me", "...");
    
    // v4 - requires full option names, abbreviated option names will now throw a GitConfigurationError
    git.raw("fetch", "--config=user.name=me", "...");
    • Ambient environment variables are filtered before passing into the git child process.

    // v3
    process.env.FOO = "bar";
    process.env.GIT_TEMPLATE_DIR = "./some/path";
    simpleGit().raw("clone"); // git child process can see both environment variables
    
    // v4
    process.env.FOO = "bar";
    process.env.GIT_TEMPLATE_DIR = "./some/path";
    simpleGit().raw("clone"); // git child process now sees only FOO
    
    simpleGit({
      // explicitly allow the named environment variable so it can pass through.
      allowEnvoronment: ["GIT_TEMPLATE_DIR"],
      // and enable the use of an unsafe behaviour
      unsafe: { allowUnsafeTemplateDir: true },
    });
    • Explicitly supplied disallowed environment variables will throw when used.

    // v3 used a single opt-in to potential unsafe actiity
    simpleGit({ unsafe: { allowUnsafeTemplateDir: true } })
      .env({ GIT_TEMPLATE_DIR: "./foo" })
      .init();
    
    // v4 uses a double opt-in, allow the behaviour and the mechanism
    simpleGit({
      allowEnvoronment: ["GIT_TEMPLATE_DIR"],
      unsafe: { allowUnsafeTemplateDir: true },
    })
      .env({ GIT_TEMPLATE_DIR: "./foo" })
      .init();
    • Removed content deprecated during the v2 to v3 major change

      • simpleGit.silent() logging is configured through environment variables in the debug package

      • simpleGit.clearQueue() this has been a noop since v3, switch to using the abort plugin

      • Accessing parsed properties of a GitResponseError through a trailing callback function are available only through the error.git property (previously properties were also spread onto the error itself with a deprecation notice).

Minor Changes

  • Support one-shot stdin via git.input(data) (string or Buffer).

Patch Changes

  • Add allowUnsafeExec detection to rebase -x and rebase --exec.

  • Parse binary rename entries without byte counts in diff summaries.

A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.