Namespace Gitteh

Namespace Detail

var gitteh = require("gitteh");

Field Detail

Method Detail

• <static> Gitteh.initRepository(path, bare, callback)
  Creates a new Git repository at the provided path. The repository will be created at the path provided, unless bare is set to true, in which case the repository will be initialized in a .git directory inside the path provided.

  Parameters:

  {String} path

  The path to initialize the new Git repository in.

  {Boolean} bare Optional

  Initialize the repository as bare or "checked out".

  {Function} callback Optional

  If provided, the repository will be created asynchronously. The provided callback will be fired when the repository has been created.
• <static> {Repository} Gitteh.openRepository(path, callback)
  Opens a Git repository at the location provided. You can either provide a path to a Git repository, which will open the repository "bare" (no working directory), or you can provide an object containing paths to the various critical Git directories needed for Git to operate.

  Parameters:

  {String|Object} path

  {String} path.gitDirectory

  The path to the Git repository folder (e.g /foo/.git)

  {String} path.workTree Optional

  The path to the Git working directory (e.g /foo). Omitting this will assume the repository is bare.

  {String} path.objectDirectory Optional

  The path to the ODB directory (e.g /foo/.git/objects). Omitting this will default to path.gitDirectory + "/objects"

  {String} path.indexFile Optional

  The path to the repository index file (e.g /foo/.git/index). Omitting this will default to path.gitDirectory + "/index"

  {Function} callback Optional

  If provided, the repository will be opened asynchronously, and the provided callback will be fired when the repository has been opened.

  Throws:

  If the path provided is incorrect, or the repository is corrupt in some way.

  Returns:

  {Repository}