英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

NodeGit

Node 与 libgit2 项目的绑定。

稳定版 (libgit2@v0.28.3): 0.28.3

有问题吗？来和我们聊天吧！

访问 slack.libgit2.org 注册，然后加入我们的 #nodegit。

由以下维护

Alex Aveillán @AlexaXs 在大量 优秀贡献者 的帮助下完成！

校友维护者

Ian Hattendorf @ianhattendorf，John Alden @zawata，Tyler Ang-Wanek @twwanek，Tim Branyen @tbranyen，John Haley @johnhaley81，Max Korp @maxkorp，Steve Smith @orderedlist，Michael Robinson @codeofinterest，和 Nick Kallen @nk

API 文档。

http://www.nodegit.org/

入门指南。

NodeGit 可以在大多数系统上开箱即用，无需任何本地依赖。

npm install nodegit

如果你在构建 Travis-CI 时收到关于 libstdc 的错误，这类错误很常见，你可以通过升级到最新的 libstdc -4.9 来解决。

在 Ubuntu 中：

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install libstdc++-4.9-dev

在特拉维斯：

addons:
  apt:
    sources:
      - ubuntu-toolchain-r-test
    packages:
      - libstdc++-4.9-dev

在 CircleCI 中：

  dependencies:
    pre:
      - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
      - sudo apt-get update
      - sudo apt-get install -y libstdc++-4.9-dev

如果你收到关于 lifecycleScripts preinstall/install 的错误，你可能缺少 Ubuntu 中的 libssl-dev:

sudo apt-get install libssl-dev

您需要在您的 Linux 机器上安装以下库：

• libpcre
• libpcreposix
• libkrb5
• libk5crypto
• libcom_err

在本地构建时，您还需要 Kerberos 和 PCRE 的开发包，因此这两个工具都必须存在于您的机器上：

• pcre-config
• krb5-配置

如果在安装过程中仍然遇到问题，您应该尝试 从源码构建 的说明。

API 示例。

克隆一个仓库并读取文件：

var Git = require("nodegit");

// Clone a given repository into the `./tmp` folder.
Git.Clone("https://github.com/nodegit/nodegit", "./tmp")
  // Look up this known commit.
  .then(function(repo) {
    // Use a known commit sha from this repository.
    return repo.getCommit("59b20b8d5c6ff8d09518454d4dd8b7b30f095ab5");
  })
  // Look up a specific file within that commit.
  .then(function(commit) {
    return commit.getEntry("README.md");
  })
  // Get the blob contents from the file.
  .then(function(entry) {
    // Patch the blob to contain a reference to the entry.
    return entry.getBlob().then(function(blob) {
      blob.entry = entry;
      return blob;
    });
  })
  // Display information about the blob.
  .then(function(blob) {
    // Show the path, sha, and filesize in bytes.
    console.log(blob.entry.path() + blob.entry.sha() + blob.rawsize() + "b");

    // Show a spacer.
    console.log(Array(72).join("=") + "\n\n");

    // Show the entire file.
    console.log(String(blob));
  })
  .catch(function(err) { console.log(err); });

模拟 git log:

var Git = require("nodegit");

// Open the repository directory.
Git.Repository.open("tmp")
  // Open the master branch.
  .then(function(repo) {
    return repo.getMasterCommit();
  })
  // Display information about commits on master.
  .then(function(firstCommitOnMaster) {
    // Create a new history event emitter.
    var history = firstCommitOnMaster.history();

    // Create a counter to only show up to 9 entries.
    var count = 0;

    // Listen for commit events from the history.
    history.on("commit", function(commit) {
      // Disregard commits past 9.
      if (++count >= 9) {
        return;
      }

      // Show the commit sha.
      console.log("commit " + commit.sha());

      // Store the author object.
      var author = commit.author();

      // Display author information.
      console.log("Author:\t" + author.name() + " <" + author.email() + ">");

      // Show the commit date.
      console.log("Date:\t" + commit.date());

      // Give some space and show the message.
      console.log("\n    " + commit.message());
    });

    // Start emitting events.
    history.start();
  });

更多示例，请查看 examples/ 文件夹。

单元测试。

在运行测试之前，您需要在本地进行构建。请参见上文。

npm test