Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

#GitRunner

Codeship Status for tqc/gitrunner

Runs simple git commands and parses the result.

##Installation

npm install gitrunner

##Usage

var git = require("gitrunner").Sync;
var status = git.status(folder);

or

var git = require("gitrunner").Async;
var result = git.status(folder, function(err, result) {});

status(folder)

Returns

{
    isRepo: true,
    changedFiles: []
}

remotes(folder)

Returns

{
    origin: 'git@github.com:tqc/gitrunner.git'
}

currentBranch(folder)

Returns

"master"

remoteBranch(folder)

Returns

"origin/master"

branches(folder)

Returns

[{
    name: "master",
    sha: "ba97757cf0ed0ffb4735d79ef8d8c4e8952bf2c0",
    message: "Commit message"
}]

branchNames(folder)

Returns

["master"]

tree(folder, treeref)

Returns

{}

fullStatus

A high level command that calls several of the lower level functions. Result is

{
    isRepo: true,
    path: 'c:\\git\\gitrunner',
    changedFiles: [
        'README.md'
        ],
    branch: 'master',
    remotes: {
        origin: 'git@github.com:tqc/gitrunner.git'
        },
    remoteBranch: 'origin/master'
}

run

For anything else, you can access git more directly:

var op = {
    params: ['remote', '-v'],
    process: function(resultObject, statusCode, output) {
        if (statusCode != 0) throw new Error("Something went wrong")
        resultObject.something = output.substr(0,5);
    }
}    
result = git.run(folder, op).something // sync
git.run(folder, op, undefined, function(err, resultObject) {}); // async

About

Node module that runs simple git commands and parses the result.

Resources

License

Releases

No releases published
You can’t perform that action at this time.