Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.<\/p>\n
Git is easy to learn and has a tiny footprint with lightning fast performance. It outclasses SCM tools like Subversion, CVS, Perforce, and ClearCase with features like cheap local branching, convenient staging areas, and multiple workflows.<\/p>\n
A light weight interface for running git commands in any node.js application.<\/p>\n
Installation<\/strong> – Easiest through npm: npm install simple-git<\/p>\n Dependencies<\/strong> – Requires git to be installed and that it can be called using the command git.<\/p>\n Usage <\/strong>– Include into your app using:<\/p>\n const simpleGit = require(‘simple-git’)(workingDirPath);<\/p>\n where the workingDirPath is optional, defaulting to the current directory.<\/p>\n Use simpleGit by chaining any of its functions together. Each function accepts an optional final argument which will be called when that step has been completed. When it is called it has two arguments – firstly an error object (or null when no error occurred) and secondly the data generated by that call.<\/p>\n Authentication<\/strong> – The easiest way to supply a username \/ password to the remote host is to include it in the URL, for example:<\/p>\n const USER = ‘something’;<\/p>\n const PASS = ‘somewhere’;<\/p>\n const REPO = ‘github.com\/username\/private-repo’;<\/p>\n const git = require(‘simple-git\/promise’);<\/p>\n const remote = `https:\/\/${USER}:${PASS}@${REPO}`;<\/p>\n git().silent(true)<\/p>\n .clone(remote)<\/p>\n .then(() => console.log(‘finished’))<\/p>\n .catch((err) => console.error(‘failed: ‘, err));<\/p>\n Be sure to enable silent mode to prevent fatal errors from being logged to stdout.<\/p>\n Environment Variables<\/strong> – Pass one or more environment variables to the child processes spawned by simple-git with the .env method which supports passing either an object of name=value pairs or setting a single variable at a time:<\/p>\n const GIT_SSH_COMMAND = “ssh -o UserKnownHostsFile=\/dev\/null -o StrictHostKeyChecking=no”;<\/p>\n const git = require(‘simple-git’);<\/p>\n git()<\/p>\n .env(‘GIT_SSH_COMMAND’, GIT_SSH_COMMAND)<\/p>\n .status((err, status) => { \/*\u00a0 *\/ })<\/p>\n const gitP = require(‘simple-git\/promise’);<\/p>\n gitP().env({ …process.env, GIT_SSH_COMMAND })<\/p>\n .status()<\/p>\n .then(status => { })<\/p>\n .catch(err => {});<\/p>\n","protected":false},"excerpt":{"rendered":" Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. It outclasses SCM tools like Subversion, CVS, Perforce, and ClearCase with features like cheap local branching,…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"categories":[8453],"tags":[8473],"class_list":["post-72644","page","type-page","status-publish","hentry","category-node-js","tag-git-and-node-js"],"acf":[],"yoast_head":"\n