https://github.com/michaelnisi/gitgo

Execute git commands
https://github.com/michaelnisi/gitgo

Last synced: about 1 month ago
JSON representation

Execute git commands

• Host: GitHub
• URL: https://github.com/michaelnisi/gitgo
• Owner: michaelnisi
• License: mit
• Created: 2012-11-12T19:23:45.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2016-03-18T17:00:23.000Z (almost 9 years ago)
• Last Synced: 2024-10-13T18:45:31.199Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 26.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitgo - the stupid git wrapper

The `gitgo` [Node](http://nodejs.org/) module makes it slightly easier to execute [Git](http://git-scm.com/) commands from Node. It's a one-off function that spawns a child process to run the Git command, returning a readable stream to expose feedback from Git.

[![Build Status](https://secure.travis-ci.org/michaelnisi/gitgo.png?branch=master)](https://travis-ci.org/michaelnisi/gitgo)

## Usage

### Cloning a repo

```js

var gitgo = require('gitgo')

var fs = require('fs')

var repo = 'git://github.com/michaelnisi/gitgo.git'

var path = '/tmp/gitgo-' + Math.floor(Math.random() * (1 << 24))

fs.mkdirSync(path)

gitgo(path, ['clone', repo]).pipe(process.stdout)

```

## API

### gitgo(path, opts)

- `path` Directory path to target repo

- `opts` Array containing the git command to execute, followed by its options, e.g. `['add', '.']`

The `gitgo` module exports a single function that returns a [Readable Stream](http://nodejs.org/api/stream.html#stream_class_stream_readable).

## Installation

```

% npm install pickup

```

## License

[MIT License](https://raw.github.com/michaelnisi/gitgo/master/LICENSE)