gry

A minimalist NodeJS wrapper for the git commands. gry stands for the Git RepositorY.

:cloud: Installation

# Using npm
npm install --save gry

# Using yarn
yarn add gry

:clipboard: Example

// Dependencies
const Repo = require("gry")
    , fs = require("fs")
    , oneByOne = require("one-by-one")
    ;

// Create the repository
var myRepo = new Repo("./foo");
oneByOne([
    myRepo.create.bind(myRepo)
  , cb => {
        console.log("> Created the repository.");
        fs.writeFile("./foo/README", "Hello World!", cb);
    }
  , cb => {
        console.log("> Created README.md");
        myRepo.exec(['add', '.'], cb);
    }
  , cb => {
        console.log("> Added the files.");
        myRepo.commit("Initial commit.", cb);
    }
  , cb => {
        console.log("> Created the initial commit.");
        cb();
    }
], function (err) {
    console.log(err ? "An error appeared: " + err.stack : "Successfully done.");
});

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`Gry(options)`

Creates a new Gry instance.

Params

Object options: An object containing the following fields:
path (String): The path to the git repository.
limit (Number): The limit of commands to run same time.

Return

Gry The Gry instance.

`exec(command, args, callback)`

Executes a git command in the repository directory.

Params

String command: The git command that should be executed in the repository directory.
Array args: An array of options passed to the spawned process. This is optional (if not provided, exec will be used instead).
Function callback: The callback function.

Return

Gry The Gry instance.

`init(callback)`

Inits the git repository.

Params

Function callback: The callback function.

Return

Gry The Gry instance.

`create(path, callback)`

Creates a git repository.

Params

String path: The path of the repository.
Function callback: The callback function

Return

Gry The Gry instance.

`commit(message, options, callback)`

Creates a commit, providing the message.

Params

String message: The commit message
String options: Additional options passed to the commit command.
Function callback: The callback function.

Return

Gry The Gry instance.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

git-package-json
git-stats
engine-tools
gh-contributions
np-init
repo-downloader
cdnjs-importer
git-stats-importer
machine-ip
repository-downloader
ssh-remote
@isysd/gpm
gpm
bloggify-tools
git-issues

gry

:cloud: Installation

:clipboard: Example

:question: Get Help

:memo: Documentation

`Gry(options)`

Params

Return

`exec(command, args, callback)`

Params

Return

`init(callback)`

Params

Return

`create(path, callback)`

Params

Return

`commit(message, options, callback)`

Params

Return

:yum: How to contribute

:sparkling_heart: Support my projects

:dizzy: Where is this library used?

:scroll: License

Current Tags

23 Versions