Skip to content

Latest commit

 

History

History
15 lines (13 loc) · 829 Bytes

overview.md

File metadata and controls

15 lines (13 loc) · 829 Bytes
Raw

Overview

dugite is a wrapper on top of the Git command line interface, with some helpers to make it easy to consume in your Node applications. The important parts:

  • GitProcess - the core of the library - GitProcess.exec is how you interact with Git
  • IGitResult - the abstraction for a result returned by Git - contains exit code and standard output/error text
  • IGitExecutionOptions - additional overrides to change the behaviour of GitProcess (see API extensibility for more information)
  • GitError - a collection of known error codes that dugite can understand
  • GitNotFoundErrorCode and RepositoryDoesNotExistErrorCode - error codes that dugite will raise for exceptional scenarios when invoking Git - you should check for these in your code.