https://github.com/enquirer/prompt-gh-clone

Prompt for the owner/name of a GitHub repository to clone.
https://github.com/enquirer/prompt-gh-clone

clone enquirer git github prompt repo repository

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/enquirer/prompt-gh-clone
• Owner: enquirer
• License: mit
• Created: 2017-06-09T11:51:23.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-10T21:43:21.000Z (almost 9 years ago)
• Last Synced: 2025-10-21T01:09:10.045Z (8 months ago)
• Topics: clone, enquirer, git, github, prompt, repo, repository
• Language: JavaScript
• Homepage: https://github.com/enquirer
• Size: 455 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# prompt-gh-clone [![NPM version](https://img.shields.io/npm/v/prompt-gh-clone.svg?style=flat)](https://www.npmjs.com/package/prompt-gh-clone) [![NPM monthly downloads](https://img.shields.io/npm/dm/prompt-gh-clone.svg?style=flat)](https://npmjs.org/package/prompt-gh-clone)  [![NPM total downloads](https://img.shields.io/npm/dt/prompt-gh-clone.svg?style=flat)](https://npmjs.org/package/prompt-gh-clone) [![Linux Build Status](https://img.shields.io/travis/enquirer/prompt-gh-clone.svg?style=flat&label=Travis)](https://travis-ci.org/enquirer/prompt-gh-clone) [![Windows Build Status](https://img.shields.io/appveyor/ci/enquirer/prompt-gh-clone.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/enquirer/prompt-gh-clone)

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

![prompt-gh-clone example](https://raw.githubusercontent.com/enquirer/prompt-gh-clone/master/example.gif)

## Usage

```js

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**

```js

clone({message: 'Repo to clone?'}, function(err) {

  if (err) console.log(err);

});

```

## About

### Related projects

* [prompt-confirm](https://www.npmjs.com/package/prompt-confirm): Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer]. | [homepage](https://github.com/enquirer/prompt-confirm "Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer].")

* [prompt-radio](https://www.npmjs.com/package/prompt-radio): Radio prompt. Can be used as a standalone prompt, or as a plugin for [Enquirer]. | [homepage](https://github.com/enquirer/prompt-radio "Radio prompt. Can be used as a standalone prompt, or as a plugin for [Enquirer].")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### 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:

```sh

$ npm install && npm test

```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)

* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).

Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 10, 2017._