prompt-gh-clone

prompt-gh-clone

Prompt for the owner/name of a GitHub repository to clone.

Usage

var clone = require('prompt-gh-clone');

clone(function(err) {
  if (err) console.log(err);
});

Options

options.dest

Set the default directory to use when the user is prompted for the destination directory.

Type: string

Default: The name of the repository

options.message

Change the prompt message.

Type: string

Default: GitHub repo to clone? (owner/name)

Example

clone({message: 'Repo to clone?'}, function(err) {
  if (err) console.log(err);
});

About

Related projects

• prompt-confirm: Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer]. | homepage
• prompt-radio: Radio prompt. Can be used as a standalone prompt, or as a plugin for [Enquirer]. | homepage

Contributing

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

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:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on September 10, 2017.