git-script
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 = ; git;
Github Clone Example
var git = ; 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;
Git Clone Example
var git = ; git;
API
git-script https://github.com/sableloki/git-script
Source: lib/git-script.js
- exports.makeRepo
- exports.commitNewFile
- exports.command
- exports.add
- exports.commit
- exports.branch
- exports.checkout
- exports.cloneFromGithub
- exports.clone
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
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
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
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
exports.commit(err, fileName, cb)
commit changes to git
Parameters:
{Object} err
Error Object{String} fileName
file to be added{Function} cb
Callback
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
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
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
exports.clone(err, url, cb)
Git clone
Parameters:
{Object} err
Error Object{String} url
git url{Function} cb
Callback
Return:
{Function}
Callback
—generated by apidox—