Noodles, Poodles and More!
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    git-scriptpublic

    git-script Build Status

    NPM

    scriptable progmatic git commands in node, this module allows to write git scripts in node.js

    Getting Started

    Install the module with: npm install git-script

    Custom Command Example

    var git = require('git-script');
     
    git.command('checkout -b develop', function(err, done){
        if(err){console.error(err)}
        done(err);
    });

    Github Clone Example

     
    var git = require('git-script');
     
    var gitConf = {
        proto: 'ssh', //the protocol in which to use to clone from github
        meta: false, //turning this to true will log out the response object and other useless shit from the function its there for debugging
    };
     
    git.cloneFromGithub('sableloki', 'dotfiles', gitConf, function(){
        console.log('Cloned Sableloki's Dotfiles YAY!!!!);
    });
     

    Git Clone Example

     
    var git = require('git-script');
     
    git.clone('git@github.com:sableloki/dotfiles.git', function(){
        console.log('Cloned Sableloki's Dotfiles YAY!!!!);
    });
     

    API

    git-script https://github.com/sableloki/git-script

    Source: lib/git-script.js

    exports.makeRepo(err, repoName)

    Make a new git repo

    Parameters:

    • {Object} err Error Object
    • {String} repoName name of folder to initialize repo (must not exist)

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.commitNewFile(err, fileName, commitMsg, cb)

    Add a new blank file to the repo and commit it

    Parameters:

    • {Object} err Error Object
    • {String} fileName name of file
    • {String} commitMsg commit message
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.command(err, com, cb)

    run a custom git command with flags

    Parameters:

    • {Object} err Error Object
    • {String} com full command minus 'git '
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.add(err, fileName, cb)

    add a file to git index

    Parameters:

    • {Object} err Error Object
    • {String} fileName file to be added
    • {Function} cb Callback

    Go: TOC | exports

    exports.commit(err, fileName, cb)

    commit changes to git

    Parameters:

    • {Object} err Error Object
    • {String} fileName file to be added
    • {Function} cb Callback

    Go: TOC | exports

    exports.branch(err, branchName, cb)

    Create a git branch

    Parameters:

    • {Object} err Error Object
    • {String} branchName name of branch
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.checkout(err, str, cb)

    run git checkout on a file

    Parameters:

    • {Object} err Error Object
    • {String} str string to pass to checkout (file, branch, etc.)
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.cloneFromGithub(err, usr, repo, path, config, cb)

    git clone from github

    Parameters:

    • {Object} err Error Object
    • {String} usr Github Username
    • {String} repo Repo Name
    • {String} path Path to save repo (defaults to __dirname/REPO_NAME)
    • {Object} config config object
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    exports.clone(err, url, cb)

    Git clone

    Parameters:

    • {Object} err Error Object
    • {String} url git url
    • {Function} cb Callback

    Return:

    {Function} Callback

    Go: TOC | exports

    —generated by apidox

    Keywords

    none

    install

    npm i git-script

    Downloadsweekly downloads

    33

    version

    0.5.0

    license

    none

    last publish

    collaborators

    • avatar