\n\n## Usage\n### Install\n npm install gulp-git --save\n\n#### 0.4.0 introduced Breaking Changes!\nGit actions which did not require a [Vinyl](https://github.com/wearefractal/vinyl) file were refactored.\nPlease review the following docs for changes:\n##Example\n\n```javascript\nvar gulp = require('gulp');\nvar git = require('gulp-git');\n\n// Run git init\n// src is the root folder for git to initialize\ngulp.task('init', function(){\n git.init(function (err) {\n if (err) throw err;\n });\n});\n\n// Run git init with options\ngulp.task('init', function(){\n git.init({args: '--quiet --bare'}, function (err) {\n if (err) throw err;\n });\n});\n\n// Run git add\n// src is the file(s) to add (or ./*)\ngulp.task('add', function(){\n return gulp.src('./git-test/*')\n .pipe(git.add());\n});\n\n// Run git add with options\ngulp.task('add', function(){\n return gulp.src('./git-test/*')\n .pipe(git.add({args: '-f -i -p'}));\n});\n\n// Run git commit\n// src are the files to commit (or ./*)\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit('initial commit'));\n});\n\n// Run git commit with a computed commit message\ngulp.task('commit', function(){\n let newVersion;\n function computeNewVersion() { newVersion = /* ... */ }\n return gulp.src('./git-test/*')\n .pipe(computeNewVersion())\n .pipe(git.commit(() => `Bumps to version ${newVersion}`));\n});\n\n// Run git commit with options\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit('initial commit', {args: '-A --amend -s'}));\n});\n\n// Run git commit without checking for a message using raw arguments\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit(undefined, {\n args: '-m \"initial commit\"',\n disableMessageRequirement: true\n }));\n});\n\n// Run git commit without appending a path to the commits\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit('initial commit', {\n disableAppendPaths: true\n }));\n});\n\n// Run git commit, passing multiple messages as if calling\n// git commit -m \"initial commit\" -m \"additional message\"\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit(['initial commit', 'additional message']));\n});\n\n// Run git commit, emiting 'data' event during progress\n// This is useful when you have long running githooks\n// and want to show progress to your users on screen\ngulp.task('commit', function(){\n return gulp.src('./git-test/*')\n .pipe(git.commit('initial commit', {emitData:true}))\n .on('data',function(data) {\n console.log(data);\n });\n});\n\n// Run git remote add\n// remote is the remote repo\n// repo is the https url of the repo\ngulp.task('addremote', function(){\n git.addRemote('origin', 'https://github.com/stevelacy/git-test', function (err) {\n if (err) throw err;\n });\n});\n\n// Run git remote remove\n// remote is the remote repo\ngulp.task('removeremote', function(){\n git.removeRemote('origin', function (err) {\n if (err) throw err;\n });\n});\n\n// Run git push\n// remote is the remote repo\n// branch is the remote branch to push to\ngulp.task('push', function(){\n git.push('origin', 'master', function (err) {\n if (err) throw err;\n });\n});\n\n// Run git push\n// branch is the current branch & remote branch to push to\ngulp.task('push', function(){\n git.push('origin', function (err) {\n if (err) throw err;\n });\n});\n\n// Run git push with options\n// branch is the remote branch to push to\ngulp.task('push', function(){\n git.push('origin', 'master', {args: \" -f\"}, function (err) {\n if (err) throw err;\n });\n});\n\n// Run git push with multiple branches and tags\ngulp.task('push', function(){\n git.push('origin', ['master', 'develop'], {args: \" --tags\"}, function (err) {\n if (err) throw err;\n });\n});\n\n// Run git pull\n// remote is the remote repo\n// branch is the remote branch to pull from\ngulp.task('pull', function(){\n git.pull('origin', 'master', {args: '--rebase'}, function (err) {\n if (err) throw err;\n });\n});\n\n// Run git pull from multiple branches\ngulp.task('pull', function(){\n git.pull('origin', ['master', 'develop'], function (err) {\n if (err) throw err;\n });\n});\n\n// Run git fetch\n// Fetch refs from all remotes\ngulp.task('fetch', function(){\n git.fetch('', '', {args: '--all'}, function (err) {\n if (err) throw err;\n });\n});\n\n// Run git fetch\n// Fetch refs from origin\ngulp.task('fetch', function(){\n git.fetch('origin', '', function (err) {\n if (err) throw err;\n });\n});\n\n// Clone a remote repo\ngulp.task('clone', function(){\n git.clone('https://github.com/stevelacy/gulp-git', function (err) {\n if (err) throw err;\n });\n});\n\n// Clone remote repo to sub folder ($CWD/sub/folder/git-test)\ngulp.task('clonesub', function() {\n git.clone('https://github.com/stevelacy/git-test', {args: './sub/folder'}, function(err) {\n // handle err\n });\n});\n\n// Tag the repo with a version\ngulp.task('tag', function(){\n git.tag('v1.1.1', 'Version message', function (err) {\n if (err) throw err;\n });\n});\n\n// Tag the repo with a version and empty message\ngulp.task('tag', function(){\n git.tag('v1.1.1', '', function (err) {\n if (err) throw err;\n });\n});\n\n// Tag the repo With signed key\ngulp.task('tagsec', function(){\n git.tag('v1.1.1', 'Version message with signed key', {signed: true}, function (err) {\n if (err) throw err;\n });\n});\n\n// Create a git branch\ngulp.task('branch', function(){\n git.branch('newBranch', function (err) {\n if (err) throw err;\n });\n});\n\n// Checkout a git branch\ngulp.task('checkout', function(){\n git.checkout('branchName', function (err) {\n if (err) throw err;\n });\n});\n\n// Create and switch to a git branch\ngulp.task('checkout', function(){\n git.checkout('branchName', {args:'-b'}, function (err) {\n if (err) throw err;\n });\n});\n\n// Merge branches to master\ngulp.task('merge', function(){\n git.merge('branchName', function (err) {\n if (err) throw err;\n });\n});\n\n// Reset a commit\ngulp.task('reset', function(){\n git.reset('SHA', function (err) {\n if (err) throw err;\n });\n});\n\n// Show the formatted git diff\ngulp.task('diff', function(){\n gulp.src('./*')\n .pipe(git.diff('master', {log: true}))\n .pipe(gulp.dest('./diff.out'));\n});\n\n// Git rm a file or folder\ngulp.task('rm', function(){\n return gulp.src('./gruntfile.js')\n .pipe(git.rm());\n});\n\ngulp.task('addSubmodule', function(){\n git.addSubmodule('https://github.com/stevelacy/git-test', 'git-test', { args: '-b master'});\n});\n\ngulp.task('updateSubmodules', function(){\n git.updateSubmodule({ args: '--init' });\n});\n\n// Working tree status\ngulp.task('status', function(){\n git.status({args: '--porcelain'}, function (err, stdout) {\n if (err) throw err;\n });\n});\n\n// Other actions that do not require a Vinyl\ngulp.task('log', function(){\n git.exec({args : 'log --follow index.js'}, function (err, stdout) {\n if (err) throw err;\n });\n});\n\n// Git clean files\ngulp.task('clean', function() {\n git.clean({ args: '-f' }, function (err) {\n if(err) throw err;\n });\n});\n\n// Get the current branch name\n\ngit.revParse({args:'--abbrev-ref HEAD'}, function (err, branch) {\n console.log('current git branch: ' + branch);\n});\n\n// Run gulp's default task\ngulp.task('default',['add']);\n```\n\n##API\n\n### git.init(opt, cb)\n`git init`\n\nCreates an empty git repo\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.init({args:'options'}, function (err) {\n //if (err) ...\n});\n```\n\n### git.clone(remote, opt, cb)\n`git clone `\n\nClones a remote repo for the first time\n\n`remote`: String, remote url\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.clone('https://remote.git', function (err) {\n //if (err) ...\n});\n```\nA desination folder or subfolder can be set with `args: ''`\n```\ngit.clone('https://remote.git', {args: './sub/folder'}, function (err) {\n //if (err) ...\n});\n```\n\n### git.add(opt)\n`git add `\n\nAdds files to repo\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024, maxFiles: Infinity}`\n\n```js\ngulp.src('./*')\n .pipe(git.add());\n});\n```\n\n### git.commit(message, opt)\n`git commit -m `\n\nCommits changes to repo\n\n`message`: String or array of strings, commit message\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024, quiet: true, disableMessageRequirement: false, disableAppendPaths: false, multiline: false}`\n\n```js\ngulp.src('./*')\n .pipe(git.commit('commit message'));\n});\n```\n\n### git.addRemote(remote, url, opt, cb)\n`git remote add `\n\nAdds remote repo url\n\n`remote`: String, name of remote, default: `origin`\n\n`url`: String, url of remote\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.addRemote('origin', 'git-repo-url', function (err) {\n //if (err) ...\n});\n```\n\n### git.removeRemote(remote, opt, cb)\n`git remote remove `\n\nRemoves remote repo\n\n`remote`: String, name of remote\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.removeRemote('origin', function (err) {\n //if (err) ...\n});\n```\n\n### git.fetch(remote, branch, opt, cb)\n`git fetch `\n\nFetches refs and objects from remote repo\n\n`remote`: String, name of remote, default: `origin`\n\n`branch`: String, branch, default: ``\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.fetch('origin', '', function (err) {\n //if (err) ...\n});\n```\n\n### git.pull(remote, branch, opt, cb)\n`git pull `\n\nPulls changes from remote repo\n\n`remote`: String, name of remote, default: `undefined`\n\n`branch`: String || Array, branch, default: `undefined`\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.pull('origin', 'master', function (err) {\n //if (err) ...\n});\n\n// without any remote or branches\ngit.pull(function(err){\n //if (err) ...\n});\n\n// with only a remote\ngit.pull('upstream', function(err){\n //if (err) ...\n});\n\n// with remote and an array of branches\ngit.pull('upstream' ['dev', 'master'], function(err){\n //if (err) ...\n});\n```\n\n### git.push(remote, branch, opt, cb)\n`git push `\n\nPushes changes to remote repo\n\n`remote`: String, name of remote, default: `origin`\n\n`branch`: String (may be `null`), branch, default: `master`\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true}`\n\n`cb`: function, passed err if any\n\n```js\ngit.push('origin', 'master', function (err) {\n //if (err) ...\n});\n```\n\n### git.tag(version, message, opt, cb)\n`git tag -a/s -m `\n\nTags repo with release version, returns all tags when used without arguments\n\n`version`: String (optional), tag name\n\n`message`: String or array of strings (optional), tag message\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.tag('v1.1.1', 'Version message', function (err) {\n //if (err) ...\n});\n```\n\nif options.signed is set to true, the tag will use the git secure key:\n`git.tag('v1.1.1', 'Version message with signed key', {signed: true});`\n\n### git.branch(branch, opt, cb)\n`git branch `\n\nCreates a new branch but doesn't switch to it\n\n(Want to switch as you create? Use `git.checkout({args:'-b'})`.)\n\n`branch`: String, branch\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.branch('development', function (err) {\n //if (err) ...\n});\n```\n\n### git.showBranch(opt, cb)\n`git show-branch `\n\nShow branches and their commits\n\n`opt`: Object (optional) `{args: 'options'}`\n\n`cb`: function, passed err if any\n\n```js\ngit.showBranch({'args': '--list -a'}, function (err) {\n //if (err) ...\n});\n```\n\n### git.checkout(branch, opt, cb)\n`git checkout `\n\nCheckout a new branch with files\n\n`branch`: String, branch\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.checkout('development', function (err) {\n //if (err) ...\n});\n```\n\nIf you want to create a branch and switch to it:\n\n```js\ngit.checkout('development', {args:'-b'}, function (err) {\n //if (err) ...\n});\n```\n\nIf you want to checkout files (e.g. revert them) use git.checkoutFiles:\n\n```js\ngulp.src('./*')\n .pipe(git.checkoutFiles());\n```\n\n### git.checkoutFiles(opt)\n`git checkout `\n\nCheckout (e.g. reset) files\n\n`opt`: Object (optional) `{args: 'options', quiet: true, maxBuffer: 200 * 1024}`\n\n```js\ngulp.src('./*')\n .pipe(git.checkoutFiles());\n```\n\n### git.merge(branch, opt, cb)\n`git merge `\n\nMerges a branch into the current branch\n\n`branch`: String, source branch\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.merge('development', function (err) {\n //if (err) ...\n});\n```\n\n### git.rm()\n`git rm `\n\nRemoves a file from git and deletes it\n\n`opt`: Object (optional) `{args: 'options', quiet: true, maxBuffer: 200 * 1024}`\n\n```js\ngulp.src('./*')\n .pipe(git.commit('commit message'));\n});\n```\n\n### git.reset(commit, opt, cb)\n`git reset `\n\nResets working directory to specified commit hash\n\n`commit`: String, commit hash or reference\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any\n\n```js\ngit.reset('HEAD' {args:'--hard'}, function (err) {\n //if (err) ...\n});\n```\n\n### git.revParse(opt, cb)\n`git rev-parse `\n\nGet details about the repository\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function, passed err if any and command stdout\n\n\n```js\ngit.revParse({args:'--short HEAD'}, function (err, hash) {\n //if (err) ...\n console.log('current git hash: '+hash);\n});\n```\n\n### git.addSubmodule()\n`git submodule add `\n\nOptions: Object\n\n`.addSubmodule('https://repository.git', 'path', {args: \"options\", quiet: true})`\n\n### git.updateSubmodule()\n`git submodule update `\n\nOptions: Object\n\n`.updateSubmodule({args: \"options\", quiet: true})`\n\n\n### git.status(opt, cb)\n`git status `\n\nShow the working tree status\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024, quiet: true}`\n\n`cb`: function (optional), passed err and command stdout\n\n```js\ngit.status({args : '--porcelain'}, function (err, stdout) {\n // if (err) ...\n});\n```\n\n### git.exec(opt, cb)\n`git `\n\nRun other git actions that do not require a Vinyl.\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024, quiet: true}`\n\n`cb`: function (optional), passed err and command stdout\n\n```js\ngit.exec({args : 'log --follow index.js'}, function (err, stdout) {\n //if (err) ...\n});\n```\n\n### git.clean(paths, opt, cb)\n`git clean `\n\nRemove untracked files from the working tree\n\n`paths`: String (optional), paths to be affected by clean operation\n\n`opt`: Object (optional), `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n`cb`: function (optional), passed err if any\n\n### git.diff(branch, opt)\n`git diff master `\n\nDiffs between git objects\n\n`branch`: String, branch name, commit name, or git tag\n\n`opt`: Object (optional) `{args: 'options', cwd: '/cwd/path', quiet: true, maxBuffer: 200 * 1024}`\n\n```js\ngulp.task('diff', function(){\n gulp.src('./*')\n .pipe(git.diff('develop', {log: true}))\n .pipe(gulp.dest('./diff.out'));\n});\n```\n\n#### You can view more examples in the [example folder.](https://github.com/stevelacy/gulp-git/tree/master/examples)\n\n \n \n\n### Possible errors:\n\n#### stdout maxBuffer exceeded\n\nReported [here](https://github.com/stevelacy/gulp-git/issues/68).\n\nIf you get this error it means that the git process doesn't have enough memory.\n\nEvery function has an additional option: `maxBuffer`.\n\n```js\ngulp.task('pull', function(){\n git.pull('origin', 'master', {args: '--rebase', maxBuffer: Infinity}, function (err) {\n if (err) throw err;\n });\n});\n```\n\n#### The command line is too long.\n\nReported [here](https://github.com/stevelacy/gulp-git/issues/201).\n\nIf the `git add` command exceeds [8191 characters on Windows](https://docs.microsoft.com/en-us/troubleshoot/windows-client/shell-experience/command-line-string-limitation#more-information) you will get this error.\n\nThe `add` function has an additional option: `maxFiles`.\n\n```js\ngulp.task('add', function(){\n return gulp.src('./git-test/*')\n .pipe(git.add({maxFiles: 8}));\n});\n```\n\n\n\n## LICENSE\n\n(MIT License)\n\nCopyright (c) 2015 Steve Lacy slacy.me\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","_attachments":{},"homepage":"http://github.com/stevelacy/gulp-git","bugs":{"url":"https://github.com/stevelacy/gulp-git/issues"},"license":"MIT"}