git-add-remote's Introduction

git-add-remote

API for adding git remotes.

Install

Install with npm:

$ npm install --save git-add-remote

Install with yarn:

$ yarn add git-add-remote

Usage

The main export is a function that must be called with the current working directory to initialize git from. Leave it undefined to use process.cwd().

var cwd = 'foo/bar';
var addRemote = require('git-add-remote')(cwd);

// async
addRemote(name, url, callback);

// sync (requires node.js v0.11.12 or higher)
addRemote.sync(name, url);

async

Examples

var addRemote = require('git-add-remote')();

addRemote('foo', 'https://foo.git', function(err) {
  if (err) return console.log(err);
});

sync

Examples

var addRemote = require('git-add-remote')();

addRemote.sync('foo', 'https://foo.git');
addRemote.sync('bar', 'https://bar.git');
addRemote.sync('baz', 'https://baz.git');

About

Related projects

gfc: Simple way to initialize a new git repository in an empty directory, add a file… more | homepage
git-branch: Get the current branch for a local git repository. | homepage
git-user-email: Get the email address of the current user from git config. | homepage
git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
git-username: Get the username from a git remote origin URL. | homepage
list-git-remotes: List the remotes for a local git repository. Sync and async. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: