Create Repository
Create a Github repository.
Installation
$ npm install github-create-repo
Usage
var createRepo = ;
createRepo( name, options, clbk )
Creates a Github repository.
var opts ='token': 'tkjorjk34ek3nj4!';;{// Check for rate limit information...if infoconsole;console;console;if errorthrow errormessage ;console;// returns <repo_data>}
The function
accepts the following options
:
- token: Github access token (required).
- useragent: user agent
string
. - org: organization name. If no organization is specified, the repository is created as a personal repository for the authenticated user.
- desc: repository description. Default:
""
. - homepage: project homepage. Default:
""
. - team: team
id
. Thisoption
is only applicable when creating organization repositories. - gitignore:
.gitignore
template name. - license:
LICENSE
template name. - private:
boolean
indicating whether to create a private repository. Default:false
. - issues:
boolean
indicating whether to enable issues. Default:true
. - wiki:
boolean
indicating whether to enable a wiki. Default:true
. - downloads:
boolean
indicating whether to enable downloads. Default:true
. - init:
boolean
indicating whether to initialize the repository with an emptyREADME
. Default:false
.
To authenticate with Github, set the token
option.
var opts ='token': 'tkjorjk34ek3nj4!';;
To specify a user agent, set the useragent
option.
var opts ='token': 'tkjorjk34ek3nj4!''useragent': 'hello-github!';;
By default, the function
creates a repository for the authenticated user. To create a repository in an organization the authenticated user is a member of, set the org
option.
var opts ='token': 'tkjorjk34ek3nj4!''org': 'math-io';;
createRepo.factory( options, clbk )
Creates a reusable function
.
var opts ='token': 'tkjorjk34ek3nj4!''org': 'math-io''private': false'issues': true'wiki': true'downloads': true'init': false;var create = createRepo;;;;// ...
The factory method accepts the same options
as createRepo()
.
Notes
- Rate limit information includes the following:
- limit: maximum number of requests a consumer is permitted to make per hour.
- remaining: number of remaining requests.
- reset: time at which the current rate limit window resets in UTC seconds.
Examples
var createRepo = ;var opts ='token': '<your_token_goes_here>''useragent': 'beep-boop-bop';;{if infoconsole;if errorthrow errormessage ;console;}
To run the example code from the top-level application directory,
$ node ./examples/index.js
Note: in order to run the example, you will need to obtain an access token with appropriate permissions and modify the token
option accordingly.
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g github-create-repo
Usage
Usage: ghcreaterepo [options] nameOptions:-h, --help Print this message.-V, --version Print the package version.--token token Github access token.-ua, --useragent ua User agent.--org organization Github organization.--desc desc Repository description.--homepage url Project homepage.--private Set the repository as private.--no-issues Disable issues.--no-wiki Disable repository wiki.--no-downloads Disable repository downloads.--team id Team id (organizations).--init Auto-initialize a repository with an empty README.--gitignore template .gitignore template.--license template License template.
Notes
- In addition to the
token
option, the token may also be specified by aGITHUB_TOKEN
environment variable. The command-line option always takes precedence. - Repository information is written to
stdout
. - Rate limit information is written to
stderr
.
Examples
Setting the access token using the command-line option:
$ DEBUG=* ghcreaterepo --token <token> beep# => '{...}'
Setting the access token using an environment variable:
$ DEBUG=* GITHUB_TOKEN=<token> ghcreaterepo beep# => '{...}'
For local installations, modify the command to point to the local installation directory; e.g.,
$ DEBUG=* ./node_modules/.bin/ghcreaterepo --token <token> beep# => '{...}'
Or, if you have cloned this repository and run npm install
, modify the command to point to the executable; e.g.,
$ DEBUG=* node ./bin/cli --token <token> beep# => '{...}'
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.