# git-exec

> Thin wrapper around the git binary.

Latest version **0.2.1** (published 2013-05-11) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install git-exec
pnpm add git-exec
yarn add git-exec
bun add git-exec
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2013-05-11 |
| First published | 2012-10-31 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.6.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alex J Burke |
| Maintainers | alexjeffburke |

## Links

- npm: https://www.npmjs.com/package/git-exec
- Repository: https://github.com/alexjeffburke/node-git-exec
- Issues: https://github.com/alexjeffburke/node-git-exec/issues
- npm.io page: https://npm.io/package/git-exec

## Recent versions

- 0.2.1 (latest) — 2013-05-11
- 0.2.0 — 2012-12-14
- 0.1.2 — 2012-12-14
- 0.1.1 — 2012-12-14
- 0.1.0 — 2012-10-31

## README

# git-exec
This library provides a very simple wrapper around the git binary.

## Getting Started
Install the module with: `npm install git-exec`

## Documentation
The library is used by constructing an object which represents a
git repository on the system.

The majority of the interaction involves an exec() method which is
invoked on instances of such objects. This method is relatively stupid in
that we do not try to parse the output or validate commands invoked.

However, we do take care to provide a means to both init / clone git
repositories and we set the working directory correctly such that
further git commands execute in the correct context.

### repo
This method will construct a repo object at the specified directory.

### init/clone
These methods will return a repo object on success as the first argument to the
callback passed to them or null on error.

```javascript
function callback(repo) {
  if (repo !== null) {
    // valid repo
  } else {
    // an error occurred
  }
}
```

## Examples

### Cloning a remote repository and checkout of origin/dev
```javascript
var Git = require('git-exec');
Git.clone(a-repo.git, 'dir', function(repo) {
  // NOTE the callback is given a reference to the git repository

  repo.exec('checkout', ['-t origin/dev'], function() {
    // ... callback to execute after branch checkout
  });
});
```

### Intialising a local repository in CWD

```javascript
var Git = require('git-exec');
Git.init('my-new-repo', null, function(repo) {
  // ... operations on repo object
});
```

### Intialising a local repository at given path
```javascript
var Git = require('git-exec');
Git.init(null, '/path/to/repo', function(repo) {
  // ... operations on repo object
});
```

As an alternative, init also supports a named repo at a specific path. Thus
for a repo named 'my-new-repo' at '/path/to' such that the full path to the
repo is /path/to/my-new-repo call init as follows:

```javascript
var Git = require('git-exec');
Git.init('my-new-repo', '/path/to', function(repo) {
  // ... operations on repo object
});
```

### Using a local git repository
```javascript
var Git = require('git-exec');
var repo = new Git('./path/to/repo');

repo.exec('pull', null, function(err, stdout) {
  // ... callback to execute after git pull
});
```

Or alternatively, to instantly create a repo and perform some operation:

```javascript
require('git-exec').repo('./path/to/repo').exec('branch', ['dev'], function() {
  // ... callback to execute
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add
unit tests for any new or changed functionality.
Lint and test your code using [grunt](https://github.com/gruntjs/grunt).

## Release History
* 0.2.1 - add tests to assert behaviour with associated fixups
* 0.2.0 - add a new repo() method to the API
* 0.1.2 - make sure cwd argument we pass to exec is made absolute
* 0.1.1 - cleanup the code; no functional changes
* 0.1.0 - initial release

## License
Copyright (c) 2013 Alex J Burke
Licensed under the MIT license.

---
_Source: https://npm.io/package/git-exec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._