https://github.com/generate/generate-ask
Adds user prompts to your generator for getting data that is commonly for rendering templates, like author name, project name, etc.
https://github.com/generate/generate-ask
Last synced: about 1 year ago
JSON representation
Adds user prompts to your generator for getting data that is commonly for rendering templates, like author name, project name, etc.
- Host: GitHub
- URL: https://github.com/generate/generate-ask
- Owner: generate
- License: mit
- Created: 2016-02-20T02:47:09.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-28T01:29:22.000Z (about 10 years ago)
- Last Synced: 2025-06-10T08:04:45.889Z (about 1 year ago)
- Language: JavaScript
- Size: 15.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-ask [](https://www.npmjs.com/package/generate-ask) [](https://npmjs.org/package/generate-ask) [](https://travis-ci.org/generate/generate-ask)
Adds user prompts to your generator for getting data that is commonly for rendering templates, like author name, project name, etc.
## Install
Install globally with [npm](https://www.npmjs.com/)
```sh
$ npm install -g generate-ask
```
## Usage
**CLI**
To use `generate-ask` as a [generate](https://github.com/generate/generate) generator:
1. Install [generate](https://github.com/generate/generate){#install} if it's not already installed
2. Make sure it's [installed globally](#install)
3. Run the generator with the following command:
```sh
gen ask
```
## Related projects
You might also be interested in these projects:
* [generate-collections](https://www.npmjs.com/package/generate-collections): Add the docs, includes, badges, and layouts collections, along with a few generic defaults to… [more](https://www.npmjs.com/package/generate-collections) | [homepage](https://github.com/jonschlinkert/generate-collections)
* [generate-defaults](https://www.npmjs.com/package/generate-defaults): Use this generator to add some common default settings to your 'generate', verb, and assemble… [more](https://www.npmjs.com/package/generate-defaults) | [homepage](https://github.com/generate/generate-defaults)
* [generate](https://www.npmjs.com/package/generate): Fast, composable, highly extendable project generator with a user-friendly and expressive API. | [homepage](https://github.com/generate/generate)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/generate/generate-ask/issues/new).
## Building docs
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install verb && npm run docs
```
Or, if [verb](https://github.com/verbose/verb) is installed globally:
```sh
$ verb
```
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/generate/generate-ask/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 24, 2016._