Scaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.
Table of Contents
- Getting started
- Next steps
Installing the CLI
To run the
default generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:
$ npm install --global generate
This adds the
gen command to your system path, allowing it to be run from any directory.
Install this module with the following command:
$ npm install --global generate-project
Run this generator's
default task with the following command:
$ gen project# or$ gen project:default
What will happen?
$ gen project will run this generator's default task, which will:
- prompt you for any information that's missing
- render templates using your answers
- generate the resulting files to the current working directory.
In the case that a file already exists on the file system, you will be prompted for feedback before overwrite any files.
You can set the destination to a new directory if you want to avoid the prompts, or avoid accidentally overwriting files with unintentional answers.
What you should see in the terminal
If completed successfully, you should see both
finished events in the terminal, like the following:
[00:44:21] starting ......[00:44:22] finished ✔
If you do not see one or both of those events, please let us know about it.
To see a general help menu and available commands for Generate's CLI, run:
$ gen help
- generate-dest: Prompts the user for the destination directory to use. Can be used from the command… more | homepage
- generate-install: Generator that automatically detects the dependencies or devDependencies to install based on the templates or… more | homepage
- generate-package: Generate a package.json from a pre-defined or user-defined template. This generator can be used from… more | homepage
Here are some suggestions!
- If you get like Generate and want to tweet about it, please feel free to mention
@generatejsor use the
- Show your love by starring Generate and
- Get implementation help on StackOverflow (please use the
generatejstag in questions)
- Gitter Discuss Generate with us on Gitter
- If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
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
This file was generated by verb-generate-readme, v0.6.0, on July 29, 2017.