GitJS

https://github.com/steveukx/git-js
Admin
A lightweight interface for running git commands in any Node.js application, offering a...
Tokens:22,711
Snippets:294
Trust Score:8.7
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install simple-git

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Commands to install the package using npm or yarn.

```bash
npm install simple-git
```

```bash
yarn add simple-git
```

--------------------------------

### Start a new repository

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Initialize a new repository, add files, commit, and push to a remote.

```javascript
simpleGit()
   .init()
   .add('./*')
   .commit('first commit!')
   .addRemote('origin', 'https://github.com/user/repo.git')
   .push('origin', 'master');
```

--------------------------------

### Check if Git is installed

Source: https://github.com/steveukx/git-js/blob/main/examples/git-version.md

Use the installed property from the version() result to verify if the Git binary is accessible.

```typescript
import { simpleGit } from 'simple-git';

const {installed} = await simpleGit().version();
if (!installed) {
  throw new Error(`Exit: "git" not available.`);
}

// ... continue using Git commands here
```

--------------------------------

### .version()

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Retrieves the version of the currently installed git.

```APIDOC
## .version()

### Description
Retrieve the major, minor, and patch version for the currently installed git. Use the .installed property of the result to determine if git is accessible.
```

--------------------------------

### Get remote repository URLs

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

List configured remote repositories.

```javascript
simpleGit().listRemote(['--get-url'], (err, data) => {
   if (!err) {
      console.log('Remote url for repository at ' + __dirname + ':');
      console.log(data);
   }
});
```

--------------------------------

### .status([options])

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Gets the status of the current repository.

```APIDOC
## .status([options])

### Description
Gets the status of the current repository, returning a StatusResult object. Additional arguments supported by git status can be supplied as an options object or array.
```

--------------------------------

### Executing independent tasks in parallel

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Calling methods on the root instance starts a new chain, allowing independent tasks to run concurrently using Promise.all.

```typescript
const git = simpleGit();
const results = await Promise.all([
   git.raw('rev-parse', '--show-cdup').catch(swallow),
   git.raw('rev-parse', '--show-prefix').catch(swallow),
]);
function swallow(err) {
   return null;
}
```

--------------------------------

### .init([bare], [options])

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Initializes a new Git repository.

```APIDOC
## .init([bare], [options])

### Description
Initializes a repository, optionally as a bare repository.

### Parameters
- **bare** (boolean) - Optional - Whether to initialize a bare repository.
- **options** (object/array) - Optional - Additional arguments supported by git init.
```

--------------------------------

### .init()

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Method to initialize a new Git repository.

```APIDOC
## .init(bare, [options])

### Description
Initializes a repository. The bare parameter is a boolean used to initialize a bare repository. Additional arguments supported by git init can be passed via options.

## .init([options])

### Description
Initializes a repository using any arguments supported by git init supplied as an options object/array.
```

--------------------------------

### Configure simple-git instance

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Setting up a simple-git instance with custom options or a base directory.

```typescript
import { simpleGit, SimpleGit, SimpleGitOptions } from 'simple-git';

const options: Partial<SimpleGitOptions> = {
   baseDir: process.cwd(),
   binary: 'git',
   maxConcurrentProcesses: 6,
   trimmed: false,
};

// when setting all options in a single object
const git: SimpleGit = simpleGit(options);

// or split out the baseDir, supported for backward compatibility
const git: SimpleGit = simpleGit('/some/path', { binary: 'git' });
```

--------------------------------

### Configure binary with arguments

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-CUSTOM-BINARY.md

Use an array to supply the command and arguments for environments like WSL or flatpak.

```typescript
simpleGit({ binary: ['wsl', 'git'] }).init();
```

```shell
wsl git init
```

--------------------------------

### GPG Signing Program Configuration

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how simple-git blocks malicious GPG program configurations and how to enable custom binaries safely.

```typescript
import { simpleGit } from 'simple-git';

// throws — default GPG program
await simpleGit()
   .raw('-c', 'gpg.program=malicious-binary', 'commit', '-S', '-m', 'signed commit');

// throws — SSH signing program
await simpleGit()
   .raw('-c', 'gpg.ssh.program=malicious-binary', 'commit', '-S', '-m', 'signed commit');

// opt in to using a custom GPG binary
await simpleGit({ unsafe: { allowUnsafeGpgProgram: true } })
   .raw('-c', 'gpg.program=/usr/local/bin/gpg2', 'commit', '-S', '-m', 'signed commit');
```

--------------------------------

### Configuring Custom Upload and Receive Packs

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how to use custom pack binaries and how to opt-in to this behavior.

```typescript
import { simpleGit } from 'simple-git';

// throws — via flag
await simpleGit()
   .raw('push', '--receive-pack=git-receive-pack-custom');

// throws — via per-remote configuration
await simpleGit()
   .raw('-c', 'remote.origin.uploadpack=/custom/upload-pack', 'fetch');

// opt in to using custom pack binaries
await simpleGit({ unsafe: { allowUnsafePack: true } })
   .raw('push', '--receive-pack=git-receive-pack-custom');
```

--------------------------------

### Initialize simple-git as an ES Module

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Importing the library using ES module syntax.

```javascript
import { simpleGit, CleanOptions } from 'simple-git';

simpleGit().clean(CleanOptions.FORCE);
```

--------------------------------

### Configuring Template Directories

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how simple-git blocks unsafe template directory configurations and how to enable them via the unsafe option.

```typescript
import { simpleGit } from 'simple-git';

// throws — via config flag
await simpleGit()
   .raw('-c', 'init.templateDir=/attacker/controlled/template', 'init', 'new-repo');

// throws — via flag
await simpleGit()
   .raw('init', '--template=/attacker/controlled/template', 'new-repo');

// throws — via environment variable
await simpleGit()
   .env('GIT_TEMPLATE_DIR', '/attacker/controlled/template')
   .init('new-repo');

// opt in to using a custom template directory
await simpleGit({ unsafe: { allowUnsafeTemplateDir: true } })
   .raw('init', '--template=/custom/template', 'new-repo');
```

--------------------------------

### Initialize simple-git

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-CUSTOM-BINARY.md

Basic initialization of the simple-git library.

```typescript
simpleGit().init();
```

```shell
git init
```

--------------------------------

### Configuring Ask-pass Programs

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how simple-git blocks external ask-pass binaries by default and how to enable them.

```typescript
import { simpleGit } from 'simple-git';

// throws — via config flag
await simpleGit()
   .raw('-c', 'core.askPass=/path/to/capture-credentials', 'clone', '--', 'https://example.com/repo');

// throws — via environment variable
await simpleGit()
   .env('GIT_ASKPASS', '/path/to/capture-credentials')
   .clone('https://example.com/repo');

// opt in to setting a custom ask-pass program
await simpleGit({ unsafe: { allowUnsafeAskPass: true } })
   .raw('-c', 'core.askPass=/usr/lib/git-core/git-gui--askpass', 'clone', '--', 'https://example.com/repo');
```

--------------------------------

### Initialize simple-git in CommonJS

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Importing the library using require in a Node.js environment.

```javascript
// require the library, main export is a function
const simpleGit = require('simple-git');
simpleGit().clean(simpleGit.CleanOptions.FORCE);

// or use named properties
const { simpleGit, CleanOptions } = require('simple-git');
simpleGit().clean(CleanOptions.FORCE);
```

--------------------------------

### Configure simple-git with custom configuration

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use the config option in the instance builder to prefix git commands with custom configuration settings.

```typescript
// configure the instance with a custom configuration property
const git: SimpleGit = simpleGit('/some/path', { config: ['http.proxy=someproxy'] });

// any command executed will be prefixed with this config
// runs: git -c http.proxy=someproxy pull
await git.pull();
```

--------------------------------

### Configuring File System Monitor

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates the default blocking of external file system monitors and the method to enable them safely.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'core.fsmonitor=malicious-monitor', 'status');

// opt in to using a custom file system monitor
await simpleGit({ unsafe: { allowUnsafeFsMonitor: true } })
   .raw('-c', 'core.fsmonitor=true', 'status');
```

--------------------------------

### Initialise a repository

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Check if a directory is a repository and initialize it if necessary.

```javascript
const git = simpleGit(__dirname);

git.checkIsRepo()
   .then((isRepo) => !isRepo && initialiseRepo(git))
   .then(() => git.fetch());

function initialiseRepo(git) {
   return git.init().then(() => git.addRemote('origin', 'https://some.git.repo'));
}
```

--------------------------------

### Configure Polyfills for Legacy Node.js

Source: https://github.com/steveukx/git-js/blob/main/docs/LEGACY_NODE_VERSIONS.md

Include necessary core-js polyfills before initializing simple-git to ensure compatibility with older Node.js environments.

```javascript
require('core-js/stable/array/flat-map');
require('core-js/stable/object/from-entries');
require('core-js/stable/object/from-entries');

const simpleGit = require('simple-git');
```

```typescript
import 'core-js/stable/array/flat-map';
import 'core-js/stable/object/from-entries';
import 'core-js/stable/object/from-entries';

import simpleGit, { SimpleGit } from 'simple-git';

const git: SimpleGit = simpleGit();
```

--------------------------------

### .raw(args, [handlerFn])

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Execute any arbitrary array of commands supported by the underlying git binary.

```APIDOC
## .raw(args, [handlerFn])

### Description
Execute any arbitrary array of commands supported by the underlying git binary.

### Parameters
- **args** (array) - Required - Array of command arguments.
- **handlerFn** (function) - Optional - The callback function.
```

--------------------------------

### Configure completion plugin in simple-git

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-COMPLETION-DETECTION.md

Initialize simple-git with the completion plugin to define custom wait times or event handling for child process completion.

```typescript
import { simpleGit, SimpleGit } from 'simple-git';

const git: SimpleGit = simpleGit({
   completion: {
      onExit: 50,
      onClose: true,
   },
});
```

--------------------------------

### Configuring Credential Helpers

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how to handle custom credential helpers and the associated opt-in requirement.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'credential.helper=/path/to/malicious-script', 'clone', '--', 'https://example.com/repo');

// opt in to using a custom credential helper
await simpleGit({ unsafe: { allowUnsafeCredentialHelper: true } })
   .raw('-c', 'credential.helper=/path/to/custom-helper', 'clone', '--', 'https://example.com/repo');
```

--------------------------------

### listConfig

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Lists the current git configuration settings.

```APIDOC
## .listConfig([scope])

### Description
Reads the current configuration. Providing a scope returns only items within that scope.

### Parameters
- **scope** (string) - Optional - The configuration scope to filter by.
```

--------------------------------

### .tags([options, ] handlerFn)

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Lists all tags with optional configuration.

```APIDOC
## .tags([options, ] handlerFn)

### Description
List all tags. Use the optional options object to set any options allowed by the git tag command.

### Parameters
- **options** (object) - Optional - Configuration options for the git tag command.
- **handlerFn** (function) - Required - Callback function to handle the operation result.
```

--------------------------------

### Execute tasks with logging

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Perform actions before and after a pull, using either chaining or async/await.

```javascript
// when using a chain
simpleGit()
   .exec(() => console.log('Starting pull...'))
   .pull((err, update) => {
      if (update && update.summary.changes) {
         require('child_process').exec('npm restart');
      }
   })
   .exec(() => console.log('pull done.'));

// when using async and optional chaining
const git = simpleGit();
console.log('Starting pull...');
if ((await git.pull())?.summary.changes) {
   require('child_process').exec('npm restart');
}
console.log('pull done.');
```

--------------------------------

### Config File Inclusion

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how to handle the include.path directive which can load external malicious configurations.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'include.path=/attacker/controlled/config', 'status');

// opt in to loading external config files
await simpleGit({ unsafe: { allowUnsafeInclude: true } })
   .raw('-c', 'include.path=/shared/team.gitconfig', 'status');
```

--------------------------------

### simpleGit(path, options)

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-SPAWN-OPTIONS.md

Configures the simple-git instance with specific spawn options to control the user or group identity of executed commands.

```APIDOC
## simpleGit(path, options)

### Description
Initializes a simple-git instance with custom spawn options to define the system user or group identity for spawned processes.

### Parameters
- **path** (string) - Required - The working directory for the git commands.
- **options** (object) - Optional - Configuration object containing `spawnOptions`.
  - **spawnOptions** (object) - Optional - Contains `uid` (number) or `gid` (number) to set the process identity.

### Request Example
```typescript
const git: SimpleGit = simpleGit('/some/path', { spawnOptions: { uid: 1000, gid: 20 } });
```
```

--------------------------------

### env(key, [value])

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Sets environment variables for the child processes spawned by simple-git.

```APIDOC
## env(key, [value])

### Description
Configures environment variables to be passed to the child processes spawned by simple-git. This can be done by passing an object of name=value pairs or by setting a single variable at a time.

### Parameters
- **key** (string | Object) - Required - The name of the environment variable or an object containing multiple name=value pairs.
- **value** (string) - Optional - The value to assign to the environment variable if the first argument is a string.
```

--------------------------------

### .fetch([options, ] handlerFn)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Updates the local working copy database with changes from the remote repository.

```APIDOC
## .fetch([options, ] handlerFn)

### Description
Updates the local working copy database with changes from the remote repository.

### Parameters
- **options** (array/object) - Optional - Standard options object or array of string commands.
- **handlerFn** (function) - Required - The callback function.
```

--------------------------------

### Configuring Git Proxy Commands

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Illustrates how to handle proxy command restrictions when performing remote operations.

```typescript
import { simpleGit } from 'simple-git';

// throws — via config flag
await simpleGit()
   .raw('-c', 'core.gitProxy=malicious-binary', 'fetch');

// throws — via environment variable
await simpleGit()
   .env('GIT_PROXY_COMMAND', 'malicious-binary')
   .fetch();

// opt in to using a custom git proxy
await simpleGit({ unsafe: { allowUnsafeGitProxy: true } })
   .env('GIT_PROXY_COMMAND', 'socks5proxywrapper')
   .fetch();
```

--------------------------------

### Configure base directory during initialization

Source: https://github.com/steveukx/git-js/blob/main/examples/git-change-working-directory.md

Sets the working directory at the time of simple-git instance creation using the baseDir property.

```typescript
import { join } from 'path';
import { simpleGit } from 'simple-git';

const git = simpleGit({ baseDir: join(__dirname, 'repos') });
```

--------------------------------

### Update root instance working directory with async/await

Source: https://github.com/steveukx/git-js/blob/main/examples/git-change-working-directory.md

Uses async/await to clone a repository and explicitly set the root instance's working directory for all subsequent tasks.

```typescript
import { join } from 'path';
import { simpleGit, SimpleGit } from 'simple-git';

const remote = `https://github.com/steveukx/git-js.git`;
const target = join(__dirname, 'repos', 'git-js');

// create a `SimpleGit` instance 
const git: SimpleGit = simpleGit();

// use that instance to do the clone
await git.clone(remote, target);

// then set the working directory of the root instance - you want all future
// tasks run through `git` to be from the new directory, rather than just tasks
// chained off this task
await git.cwd({ path: target, root: true });
```

--------------------------------

### List remote repositories

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use this method to list remote repositories with optional arguments passed as an array.

```javascript
git.listRemote(['--heads', '--tags'], console.log)
```

--------------------------------

### Merge Driver Configuration

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how to handle merge driver and tool configurations that could otherwise execute arbitrary code.

```typescript
import { simpleGit } from 'simple-git';

// throws — custom merge driver
await simpleGit()
   .raw('-c', 'merge.union.driver=malicious-merger %O %A %B', 'merge', 'feature-branch');

// throws — merge tool command
await simpleGit()
   .raw('-c', 'mergetool.custom.cmd=malicious-binary $MERGED', 'mergetool');

// opt in to using custom merge drivers
await simpleGit({ unsafe: { allowUnsafeMergeDriver: true } })
   .raw('-c', 'mergetool.vimdiff.path=/usr/bin/vim', 'mergetool');
```

--------------------------------

### .exec(handlerFn)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Calls a simple function in the current step.

```APIDOC
## .exec(handlerFn)

### Description
Calls a simple function in the current step.

### Parameters
- **handlerFn** (function) - Required - The function to execute.
```

--------------------------------

### Configure custom binary path

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-CUSTOM-BINARY.md

Specify a custom binary path for environments where git is not in the system PATH.

```typescript
simpleGit({ binary: 'my-custom-git' });
```

--------------------------------

### Handle status with async/await

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Demonstrates wrapping git commands in an async function with error handling.

```javascript
async function status(workingDir) {
   let statusSummary = null;
   try {
      statusSummary = await simpleGit(workingDir).status();
   } catch (e) {
      // handle the error
   }

   return statusSummary;
}

// using the async function
status(__dirname + '/some-repo').then((status) => console.log(status));
```

--------------------------------

### Configuring External Diff Tools

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how to handle external diff tool configurations, which are blocked by default to prevent unauthorized file access.

```typescript
import { simpleGit } from 'simple-git';

// throws — global external diff via config
await simpleGit()
   .raw('-c', 'diff.external=malicious-diff-tool', 'diff');

// throws — per-driver diff command via config
await simpleGit()
   .raw('-c', 'diff.pdf.command=malicious-diff-tool', 'diff', 'document.pdf');

// throws — via environment variable
await simpleGit()
   .env('GIT_EXTERNAL_DIFF', 'malicious-diff-tool')
   .diff();

// opt in to using a custom diff tool
await simpleGit({ unsafe: { allowUnsafeDiffExternal: true } })
   .env('GIT_EXTERNAL_DIFF', '/usr/local/bin/my-diff-tool')
   .diff();
```

--------------------------------

### .checkout() / .checkoutBranch() / .checkoutLocalBranch()

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods for checking out tags, revisions, or branches.

```APIDOC
## .checkout(checkoutWhat, [options])

### Description
Checks out the supplied tag, revision, or branch.

## .checkout(options)

### Description
Checks out a tag or revision using the supplied options object.

## .checkoutBranch(branchName, startPoint)

### Description
Checks out a new branch from the supplied start point.

## .checkoutLocalBranch(branchName)

### Description
Checks out a new local branch.
```

--------------------------------

### Defining Command Aliases

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates the restriction on defining git aliases and the required opt-in.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'alias.ls=!ls -la', 'ls');

// opt in to defining aliases
await simpleGit({ unsafe: { allowUnsafeAlias: true } })
   .raw('-c', 'alias.ls=!ls -la', 'ls');
```

--------------------------------

### git.show

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Displays various types of objects or file content from the repository.

```APIDOC
## .show(options)

### Description
Shows various types of objects, such as file content at a certain commit.

### Parameters
- **options** (string/object/array) - Required - The options or object identifier supported by the git show command.

## .showBuffer(options)

### Description
Returns the Buffer content directly, useful for binary files.

### Parameters
- **options** (string/object/array) - Required - The options or object identifier supported by the git show command.
```

--------------------------------

### Specifying Options

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

How to pass custom options to git tasks using objects or arrays.

```APIDOC
## Specifying Options

### Description
Tasks that accept custom options (e.g., pull, commit) can receive them as an object or an array of strings. These are merged as trailing arguments in the command string.

### Options as an Object
- When the value is a string, it is included as `name=value`.
- When the value is an array of strings or numbers, each element is included as a separate `name=value` pair.

### Options as an Array
- An array of strings can be supplied to be merged directly into the task's commands.
```

--------------------------------

### Execute raw git commands

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use the raw method to execute arbitrary git commands by passing an array of arguments. Supports both callback and promise-based patterns, with an option to trim output.

```javascript
const path = '/path/to/repo';
const commands = ['config', '--global', 'advice.pushNonFastForward', 'false'];

// using an array of commands and node-style callback
simpleGit(path).raw(commands, (err, result) => {
   // err is null unless this command failed
   // result is the raw output of this command
});

// using a var-args of strings and awaiting rather than using the callback
const result = await simpleGit(path).raw(...commands);

// automatically trim trailing white-space in responses
const result = await simpleGit(path, { trimmed: true }).raw(...commands);
```

--------------------------------

### Configure and use progress events

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-PROGRESS-EVENTS.md

Define a progress handler and pass it to the simpleGit configuration to receive updates during Git operations.

```typescript
import { simpleGit, SimpleGit, SimpleGitProgressEvent } from 'simple-git';

const progress = ({method, stage, progress}: SimpleGitProgressEvent) => {
   console.log(`git.${method} ${stage} stage ${progress}% complete`);
}
const git: SimpleGit = simpleGit({baseDir: '/some/path', progress});

// pull automatically triggers progress events when the progress plugin is configured
await git.pull();

// supply the `--progress` option to any other command that supports it to receive
// progress events into your handler
await git.raw('pull', '--progress');
```

--------------------------------

### .clone() / .mirror()

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods for cloning remote repositories.

```APIDOC
## .clone(repoPath, [localPath, [options]])

### Description
Clones a remote repository to a local directory.

## .clone(repoPath, [options])

### Description
Clones a remote repository to a directory in the current working directory.

## .mirror(repoPath, [localPath, [options]])

### Description
Behaves the same as .clone but with the --mirror flag enabled.
```

--------------------------------

### show

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Shows various types of objects or file content.

```APIDOC
## .show(options)

### Description
Shows various types of objects, such as file content at a certain commit.

### Parameters
- **options** (string/object/array) - Required - The object identifier or options supported by git show.
```

--------------------------------

### Chain Git tasks with Promises

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Demonstrates chaining multiple Git tasks using await or individual await calls.

```javascript
const git = simpleGit();

// chain together tasks to await final result
await git.init().addRemote('origin', '...remote.git');

// or await each step individually
await git.init();
await git.addRemote('origin', '...remote.git');
```

--------------------------------

### Configuring Diff Text Conversion

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Illustrates the restriction on diff text conversion binaries and the opt-in path for custom converters.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'diff.pdf.textconv=malicious-converter', 'diff', 'document.pdf');

// opt in to using a custom text converter
await simpleGit({ unsafe: { allowUnsafeDiffTextConv: true } })
   .raw('-c', 'diff.pdf.textconv=pdftotext', 'diff', 'document.pdf');
```

--------------------------------

### .customBinary(gitPath)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Sets the command to use to reference git, allowing for the use of a git binary not available on the path environment variable.

```APIDOC
## .customBinary(gitPath)

### Description
Sets the command to use to reference git, allowing for the use of a git binary not available on the path environment variable.

### Parameters
- **gitPath** (string) - Required - The path to the git binary.
```

--------------------------------

### .rebase([options,] handlerFn)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Rebases the repository.

```APIDOC
## .rebase([options,] handlerFn)

### Description
Rebases the repository using the provided options.

### Parameters
- **options** (array/object) - Optional - Array of string parameters or object of options.
- **handlerFn** (function) - Required - The callback function.
```

--------------------------------

### Configuring Pagers

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how to manage pager binary restrictions for command output.

```typescript
import { simpleGit } from 'simple-git';

// throws — via config flag
await simpleGit()
   .raw('-c', 'core.pager=malicious-binary', 'log');

// throws — via environment variable
await simpleGit()
   .env('GIT_PAGER', 'malicious-binary')
   .log();

// opt in to using a custom pager
await simpleGit({ unsafe: { allowUnsafePager: true } })
   .env('GIT_PAGER', 'less -R')
   .log();
```

--------------------------------

### .diffSummary([options])

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Creates a summary of the diff for files in the repository.

```APIDOC
## .diffSummary([options])

### Description
Summarizes the diff for files in the repository, using the --stat format by default.

### Parameters
- **options** (object/array) - Optional - Additional arguments to override the default format.
```

--------------------------------

### Submodule Update Strategy Configuration

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Demonstrates how Git submodule update strategies can trigger shell commands and how to enable them safely.

```typescript
import { simpleGit } from 'simple-git';

// throws — shell command as update strategy
await simpleGit()
   .raw('-c', 'submodule.evil.update=!malicious-binary', 'submodule', 'update');

// opt in to using a custom submodule update strategy
await simpleGit({ unsafe: { allowUnsafeSubmodule: true } })
   .raw('-c', 'submodule.vendor.update=!custom-update-script', 'submodule', 'update');
```

--------------------------------

### Push with arguments

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Push changes using specific git arguments like -u.

```javascript
simpleGit()
   .add('./*')
   .commit('first commit!')
   .addRemote('origin', 'some-repo-url')
   .push(['-u', 'origin', 'master'], () => console.log('done'));
```

--------------------------------

### URL Rewriting Configuration

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how URL rewriting can redirect traffic to arbitrary hosts and the required opt-in configuration.

```typescript
import { simpleGit } from 'simple-git';

// throws — redirects github.com traffic to an attacker host
await simpleGit()
   .raw('-c', 'url.https://evil.example.com.insteadOf=https://github.com', 'clone', 'https://github.com/org/repo');

// opt in to using URL rewriting
await simpleGit({ unsafe: { allowUnsafeUrlRewrite: true } })
   .raw('-c', 'url.git://internal.mirror.insteadOf=https://github.com', 'clone', 'https://github.com/org/repo');
```

--------------------------------

### Configuring SSH Commands

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows the restriction on custom SSH binaries and the opt-in mechanism for trusted SSH configurations.

```typescript
import { simpleGit } from 'simple-git';

// throws — via config flag
await simpleGit()
   .raw('-c', 'core.sshCommand=malicious-binary', 'clone', 'git@example.com:repo.git');

// throws — via environment variable
await simpleGit()
   .env('GIT_SSH_COMMAND', 'malicious-binary')
   .clone('git@example.com:repo.git');

// opt in to using a custom SSH binary
await simpleGit({ unsafe: { allowUnsafeSshCommand: true } })
   .env('GIT_SSH_COMMAND', 'ssh -i ~/.ssh/deploy_key')
   .clone('git@example.com:repo.git');
```

--------------------------------

### Configure locale environment variables

Source: https://github.com/steveukx/git-js/blob/main/docs/NON_ENGLISH_LOCALE.md

Sets the LANG and LC_ALL environment variables to 'C' to ensure git output is parsed correctly.

```typescript
import { simpleGit } from 'simple-git';

const git = simpleGit().env({
   LANG: 'C',
   LC_ALL: 'C',
});
const branches = await git.branchLocal();
```

--------------------------------

### Specify Options as an Object

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use an object to pass command options. String values result in name=value pairs, while null values result in flags.

```javascript
// results in 'git pull origin master --no-rebase'
git.pull('origin', 'master', { '--no-rebase': null });

// results in 'git pull origin master --rebase=true'
git.pull('origin', 'master', { '--rebase': 'true' });
```

--------------------------------

### Managing remote repositories

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Methods for adding, listing, and removing remote repository references.

```javascript
.addRemote(name, repo, [options])
```

```javascript
.getRemotes([verbose])
```

```javascript
git.listRemote(['--heads', '--tags'], console.log)
```

```javascript
.remote([options])
```

```javascript
.removeRemote(name)
```

--------------------------------

### .env(name, value)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Set environment variables to be passed to the spawned child processes.

```APIDOC
## .env(name, value)

### Description
Set environment variables to be passed to the spawned child processes.

### Parameters
- **name** (string) - Required - The name of the environment variable.
- **value** (string) - Required - The value to assign to the environment variable.
```

--------------------------------

### Checkout branches and revisions

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Checks out tags, revisions, or branches with optional configuration.

```javascript
.checkout(checkoutWhat , [options])
```

```javascript
.checkout(options)
```

```javascript
.checkoutBranch(branchName, startPoint)
```

```javascript
.checkoutLocalBranch(branchName)
```

--------------------------------

### .branch([options])

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Executes git branch commands based on provided options.

```APIDOC
## .branch([options])

### Description
Runs git branch commands using the supplied options. Returns a BranchSummaryResult when listing branches or a BranchSingleDeleteResult when deleting a branch.

### Parameters
- **options** (object) - Optional - Arguments supported by the git branch command.
```

--------------------------------

### showBuffer

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Shows object content as a Buffer.

```APIDOC
## .showBuffer(options)

### Description
Returns the content of an object as a Buffer, useful for binary files.

### Parameters
- **options** (string/object/array) - Required - The object identifier or options supported by git show.
```

--------------------------------

### .applyPatch(patch, [options])

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Applies a single string patch or an array of string patches to the repository.

```APIDOC
## .applyPatch(patch, [options])

### Description
Applies a single string patch or an array of string patches (as generated by git diff) to the repository. Optionally accepts configuration options for the git apply command.

### Parameters
- **patch** (string|string[]) - Required - The patch content or array of patches.
- **options** (object) - Optional - Configuration options for the git apply command.

### Returns
- **stdout** (string) - The unmodified string response from the git binary.
```

--------------------------------

### .clean(mode) / .clean(cleanSwitches, [options])

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Cleans the working tree. Supports a simple mode string or a combination of switches and options.

```APIDOC
## .clean(mode)

### Description
Cleans the working tree.

### Parameters
- **mode** (string) - Required - "n" for dry run or "f" for force.

## .clean(cleanSwitches, [options])

### Description
Cleans the working tree using specific switches and optional configuration.

### Parameters
- **cleanSwitches** (string) - Required - A string containing any number of supported single character options.
- **options** (object) - Optional - Standard options object.
```

--------------------------------

### Specify Options as an Array

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Pass an array of strings to merge options directly into the command string.

```javascript
// results in 'git pull origin master --no-rebase'
git.pull('origin', 'master', ['--no-rebase']);
```

--------------------------------

### Overriding Allowed Protocols

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how to handle helper transport overrides and the necessary opt-in configuration.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('clone', 'ext::git-server-alias foo %G/repo', '-c', 'protocol.ext.allow=always');

// allows calling clone with a helper transport
await simpleGit({ unsafe: { allowUnsafeProtocolOverride: true } })
   .raw('clone', 'ext::git-server-alias foo %G/repo', '-c', 'protocol.ext.allow=always');
```

--------------------------------

### Configure author settings

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Set global or per-commit author configuration.

```javascript
simpleGit()
   .addConfig('user.name', 'Some One')
   .addConfig('user.email', 'some@one.com')
   .commit('committed as "Some One"', 'file-one')
   .commit('committed as "Another Person"', 'file-two', {
      '--author': '"Another Person <another@person.com>"',
   });
```

--------------------------------

### .tag(args, handlerFn)

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Executes git tag commands with provided arguments.

```APIDOC
## .tag(args, handlerFn)

### Description
Runs any supported git tag commands with arguments passed as an array of strings.

### Parameters
- **args** (array) - Required - An array of strings representing git tag command arguments.
- **handlerFn** (function) - Required - Callback function to handle the operation result.
```

--------------------------------

### Enable logging via environment variable

Source: https://github.com/steveukx/git-js/blob/main/docs/DEBUG-LOGGING-GUIDE.md

Set the DEBUG environment variable before executing the node process to enable logging.

```bash
"DEBUG=simple-git" node ./your-app.js
```

--------------------------------

### Catch errors in async chains

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Shows how to wrap an entire chain in a try/catch block to handle errors.

```javascript
const git = simpleGit();
try {
   await git.init();
   await git.addRemote(name, repoUrl);
} catch (e) {
   /* handle all errors here */
}
```

--------------------------------

### Git Configuration Paths via Environment Variables

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Illustrates the blocking of environment variables that override Git configuration paths.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .env('GIT_CONFIG_GLOBAL', '/attacker/controlled/gitconfig')
   .clone('https://example.com/repo');

// opt in to overriding git configuration paths
await simpleGit({ unsafe: { allowUnsafeConfigPaths: true } })
   .env('GIT_CONFIG_GLOBAL', '/custom/global/gitconfig')
   .clone('https://example.com/repo');
```

--------------------------------

### countObjects

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Queries pack and disk usage properties of the local repository.

```APIDOC
## .countObjects()

### Description
Queries the pack and disk usage properties of the local repository. Disk sizes are reported in Kb.
```

--------------------------------

### .merge(options)

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Runs a git merge operation using the provided configuration options.

```APIDOC
## .merge(options)

### Description
Runs a merge using any configuration options supported by git merge. Conflicts result in an error response, returning a MergeSummary instance.

### Parameters
- **options** (object/array) - Optional - Configuration options supported by git merge.
```

--------------------------------

### Configuring Hooks Path

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Shows how to restrict custom hooks paths to prevent arbitrary script execution.

```typescript
import { simpleGit } from 'simple-git';

// throws
await simpleGit()
   .raw('-c', 'core.hooksPath=/attacker/controlled/hooks', 'commit', '-m', 'message');

// opt in to using a custom hooks path
await simpleGit({ unsafe: { allowUnsafeHooksPath: true } })
   .raw('-c', 'core.hooksPath=/custom/shared/hooks', 'commit', '-m', 'message');
```

--------------------------------

### Submodule Methods

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods for managing git submodules.

```APIDOC
## Submodule Methods

- `.subModule(options)`: Run a git submodule command with one or more arguments.
- `.submoduleAdd(repo, path)`: Adds a new submodule.
- `.submoduleInit([options])`: Initialises submodules.
- `.submoduleUpdate(subModuleName, [options])`: Updates submodules.
```

--------------------------------

### Environment-based Configuration Injection

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-UNSAFE-ACTIONS.md

Covers the blocking of environment-based configuration injection and the opt-in mechanism.

```typescript
import { simpleGit } from 'simple-git';

// throws — GIT_CONFIG_COUNT triggers the check; the injected key is also evaluated
await simpleGit()
   .env({
      GIT_CONFIG_COUNT: '1',
      GIT_CONFIG_KEY_0: 'core.hooksPath',
      GIT_CONFIG_VALUE_0: '/attacker/hooks',
   })
   .commit('message');

// opt in to using environment-based configuration injection
await simpleGit({ unsafe: { allowUnsafeConfigEnvCount: true } })
   .env({
      GIT_CONFIG_COUNT: '1',
      GIT_CONFIG_KEY_0: 'user.email',
      GIT_CONFIG_VALUE_0: 'ci-bot@example.com',
   })
   .commit('CI build commit');
```

--------------------------------

### simple-git API Methods

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

A collection of methods provided by the simple-git library to perform git operations programmatically.

```APIDOC
## .customBinary(gitPath)
Sets the command to use to reference git, allowing for the use of a git binary not available on the path environment variable.

## .env(name, value)
Sets environment variables to be passed to the spawned child processes.

## .exec(handlerFn)
Calls a simple function in the current step.

## .fetch([options, ] handlerFn) / .fetch(remote, branch, handlerFn) / .fetch(handlerFn)
Updates the local working copy database with changes from a remote repository. Supports optional configuration via options object or array of string commands.

## .outputHandler(handlerFn)
Attaches a handler that receives the command name, stdout, and stderr readable streams from the child process.

## .raw(args, [handlerFn])
Executes any arbitrary array of commands supported by the underlying git binary.

## .rebase([options,] handlerFn)
Rebases the repository using options supplied as an array of string parameters or an options object.

## .revert(commit , [options , [handlerFn]])
Reverts one or more commits in the working copy. Supports commit-ish values or ranges.
```

--------------------------------

### Pull and handle tags or changes

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Update a repository and perform actions based on tags or changes detected.

```javascript
simpleGit(__dirname + '/some-repo')
   .pull()
   .tags((err, tags) => console.log('Latest available tag: %s', tags.latest));

// update repo and when there are changes, restart the app
simpleGit().pull((err, update) => {
   if (update && update.summary.changes) {
      require('child_process').exec('npm restart');
   }
});
```

--------------------------------

### Enable Debug Logging for File Existence

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use the DEBUG environment variable to trace file existence checks when troubleshooting working directory access issues.

```bash
DEBUG=@kwsites/file-exists,simple-git node ./your-app.js
```

--------------------------------

### .diff() and .diffSummary()

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods to retrieve diff information from the repository.

```APIDOC
## .diff([options])

### Description
Gets the diff of the current repository compared to the last commit. Optionally accepts arguments supported by git diff.

### Returns
- **string** - The raw diff output.

## .diffSummary([options])

### Description
Creates a DiffResult to summarize the diff for files in the repository. Uses the --stat format by default, which can be overridden via options.
```

--------------------------------

### Check for a specific Git version

Source: https://github.com/steveukx/git-js/blob/main/examples/git-version.md

Compare the version returned by git.version() against a minimum requirement using semver.

```typescript
import { simpleGit } from 'simple-git';
import { lt } from 'semver';

const versionResult = await simpleGit().version();
if (lt(String(versionResult), '2.1.0')) {
  throw new Error(`Exit: "git" must be at least version 2.1.0.`);
}

// ... continue using Git commands here that are compatible with 2.1.0 or higher
```

--------------------------------

### Perform a manual grep search with options

Source: https://github.com/steveukx/git-js/blob/main/examples/git-grep.md

Executes a grep search by manually providing an array of options instead of using the builder.

```typescript
import simpleGit from 'simple-git';

console.log(await simpleGit().grep('search-term', ['-e', 'another search term']));
```

--------------------------------

### Enable logging programmatically

Source: https://github.com/steveukx/git-js/blob/main/docs/DEBUG-LOGGING-GUIDE.md

Use the debug library's enable method to activate logging within the application code.

```javascript
const debug = require('debug');
const simpleGit = require('simple-git');

debug.enable('simple-git,simple-git:*');
simpleGit().init().then(() => console.log('DONE'));
```

```typescript
import debug from 'debug';
import { simpleGit } from 'simple-git';

debug.enable('simple-git,simple-git:*');
simpleGit().init().then(() => console.log('DONE'));
```

--------------------------------

### Clone repositories

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Clones remote repositories to local paths or mirrors them.

```javascript
.clone(repoPath, [localPath, [options]])
```

```javascript
.clone(repoPath, [options])
```

```javascript
mirror(repoPath, [localPath, [options]])
```

--------------------------------

### getConfig

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Retrieves the value for a specific configuration key.

```APIDOC
## .getConfig(key, [scope])

### Description
Gets the value(s) for a named key. Optionally limit the search to a specific scope.

### Parameters
- **key** (string) - Required - The configuration key to retrieve.
- **scope** (string) - Optional - The configuration scope to search (worktree, local, global, system).
```

--------------------------------

### Execute tasks with callbacks

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Uses trailing callback arguments to handle results for individual Git tasks.

```javascript
const git = simpleGit();
git.init(onInit).addRemote('origin', 'git@github.com:steveukx/git-js.git', onRemoteAdd);

function onInit(err, initResult) {}
function onRemoteAdd(err, addRemoteResult) {}
```

--------------------------------

### Monitor progress events

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Configure progress callbacks to track long-running git operations.

```javascript
const git = simpleGit({
   progress({ method, stage, progress }) {
      console.log(`git.${method} ${stage} stage ${progress}% complete`);
   },
});
git.checkout('https://github.com/user/repo.git');
```

--------------------------------

### .cwd(workingDirectory)

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Sets the working directory for git commands. Can be applied to the root instance or a specific chain.

```APIDOC
## .cwd(workingDirectory)

### Description
Sets the working directory for all future commands. Note that this will change the working directory for the root instance, and any chain created from the root will also be affected.

### Parameters
- **workingDirectory** (string) - Required - The path to the directory to be used as the working directory.

## .cwd({ path, root = false })

### Description
Sets the working directory for all future commands either in the current chain of commands or in the main instance.

### Parameters
- **path** (string) - Required - The path to the directory.
- **root** (boolean) - Optional - If true, changes the directory for the main instance. If false or omitted, changes it only for the current chain.
```

--------------------------------

### Handle errors in async Git chains

Source: https://github.com/steveukx/git-js/blob/main/readme.md

Use try/catch blocks to manage errors for the entire chain or individual steps.

```javascript
const git = simpleGit();
try {
   await git.init();
   await git.addRemote(name, repoUrl);
} catch (e) {
   /* handle all errors here */
}
```

```javascript
const git = simpleGit();
try {
   await git.init().catch(ignoreError);
   await git.addRemote(name, repoUrl);
} catch (e) {
   /* handle all errors here */
}

function ignoreError() {}
```

--------------------------------

### git mv

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods for renaming or moving files.

```APIDOC
## .mv(from, to)

### Description
Renames or moves a single file or a collection of files.

### Parameters
- **from** (string|array) - Required - The source file path or array of file paths.
- **to** (string) - Required - The destination path or directory.
```

--------------------------------

### Handle merge errors with async/await

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Use try/catch blocks to handle Git errors, accessing parsed error content via err.git.

```javascript
try {
   const mergeSummary = await git.merge();
   console.log(`Merged ${mergeSummary.merges.length} files`);
} catch (err) {
   // err.message - the string summary of the error
   // err.stack - some stack trace detail
   // err.git - where a parser was able to run, this is the parsed content

   console.error(`Merge resulted in ${err.git.conflicts.length} conflicts`);
}
```

--------------------------------

### remote

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Methods for managing and listing remote repositories.

```APIDOC
## .addRemote(name, repo, [options])
### Description
Adds a new named remote to be tracked.

## .getRemotes([verbose])
### Description
Retrieves a list of named remotes. Set verbose to true to include URLs and purpose.

## .listRemote([options])
### Description
Lists remote repositories using git ls-remote options.

## .remote([options])
### Description
Executes a raw git remote command with provided options.

## .removeRemote(name)
### Description
Removes the specified remote.
```

--------------------------------

### addConfig

Source: https://github.com/steveukx/git-js/blob/main/simple-git/readme.md

Adds a configuration property to the git repository.

```APIDOC
## .addConfig(key, value, append = false, scope = 'local')

### Description
Adds a local configuration property. Use the scope argument to specify where to save the setting.

### Parameters
- **key** (string) - Required - The configuration key.
- **value** (string) - Required - The value to set.
- **append** (boolean) - Optional - If true, appends the value instead of overwriting.
- **scope** (string) - Optional - The configuration scope (worktree, local, global, system).
```

--------------------------------

### Update binary on existing instance

Source: https://github.com/steveukx/git-js/blob/main/docs/PLUGIN-CUSTOM-BINARY.md

Change the binary configuration dynamically on an existing instance using customBinary.

```typescript
const git = await simpleGit().init();
git.customBinary('./custom/git').raw('add', '.');
```

```shell
git init
./custom/git add .
```
Tokens:
Raw