Nuclear Power Manager

    gitcreate

    1.0.0 • Public • Published

    gitcreate NPM version Build Status Dependency Status Coveralls

    Create a Github repository with only username/repo.
    Support CLI and Promises.

    Install Nodei.co stats

    Install with npm

    $ npm install gitcreate -g
    $ gitcreate --help
    

    Usage

    You can also see bin/cli.js, tests for more example usages

    async promise example 1

    var gitcreate = require('gitcreate');
    var options = {
      token: 'my super secret token',
      name: 'username/reponame',
      promise: true
    }
    gitcreate(options)
      .then(console.log)
      .catch(console.error)

    async callback example

    var gitcreate = require('gitcreate');
    var options = {
      name: 'username/reponame',
      token: 'my super secret token',
      homepage: 'http://windowsucks.com',
      description: 'some non-default description',
      promise: false
    }
    gitcreate(options, function(err, res) {
      if (err) {
        console.error(err)
        return;
      }
      //=> res.response = request response object
      //=> res.visit = final url for the repo
      console.log(res.visit);
    })

    async promise example 2

    var gitcreate = require('gitcreate');
    var options = {
      token: 'my super secret token',
      description: 'some non-default description',
      promise: true
    }
    gitcreate('username/reponame', options)
      .then(console.log)
      .catch(console.error)

    Tests

    You can also use make test

    $ npm test
    

    API

    gitcreate(repo, [options], [callback])

    • repo {String|Object} If repo is string, must provide options
    • options {Object|Fn} Options can be callback, if repo is object and .promise: false
      • name {String} User and name of the repo you want to create (as user/repo)
      • token {String} Github token to auth for api calls
      • promise {Boolean} Handle response with promise - true/false or empty
      • homepage {String} Website that will be set for the repository
      • description {String} Description for the repo
    • callback {Fn} Node-style callback, same as always

    CLI

    $ gitcreate --help
    

    Flags

    Flags can be used in any order.

    • --help
    • --version
    • -n|--name|1st arg {String} User and name of the repo you want to create (as user/repo)
    • -t|--token|2nd arg {String} Github token to auth for api calls
    • -p|--promise|3rd arg {Boolean} Handle response with promise - true/false or empty
    • -h|--homepage|4th arg {String} website that will be set for the repository
    • -d|--description|5th arg {String} description for the repo

    Example usage

    $ gitcreate tunnckoCore/awesomeRepo githubTokenHere
    $ gitcreate tunnckoCore/newRepo ghToken false google.com "some long desc"
    $ gitcreate tunnckoCore/gitcreate -p --token "secret" -d "long desc"
    $ gitcreate -p --name tunnckoCore/gitcreate
    $ gitcreate --homepage "www.twitter.com" -t mySecretToken -n tunnckoCore/gitcreate
    

    Authors & Contributors

    Charlike Mike Reagent author tips

    License MIT license

    Copyright (c) 2014 Charlike Mike Reagent, contributors.
    Released under the MIT license.

    Install

    npm i gitcreate

    DownloadsWeekly Downloads

    10

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • vanchoy
    • tunnckocore