Repository files navigation

Scaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.

Installing the CLI

To run thedefault generator from the command line, you'll need to installGenerate globally first. You can do that now with the following command:

$ npm install --global generate

This adds thegen command to your system path, allowing it to be run from any directory.

Install generate-project

Install this module with the following command:

$ npm install --global generate-project

Run this generator'sdefaulttask with the following command:

$ gen project# or$ gen project:default

What will happen?

Running$ gen project will run this generator'sdefault task, which will:

1. prompt you for any information that's missing
2. render templates using your answers
3. generatethe resulting files to the current working directory.

Conflict detection

In the case that a file already exists on the file system, you will beprompted for feedbackbefore overwrite any files.

You canset 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 bothstarting andfinished 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, pleaselet us know about it.

To see a general help menu and available commands for Generate's CLI, run:

$ genhelp

• 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

Are you usingGenerate in your project? Have you published agenerator and want to share your project with the world?

Here are some suggestions!

• If you get like Generate and want to tweet about it, please feel free to mention@generatejs or use the#generatejs hashtag
• Show your love by starringGenerate andgenerate-project
• Get implementation help onStackOverflow (please use thegeneratejs tag in questions)
• Gitter Discuss Generate with us onGitter
• If you publish an generator, thank you! To make your project as discoverable as possible, please add the keywordgenerategenerator to package.json.

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

Please read thecontributing 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&& npmtest

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Copyright © 2017,Jon Schlinkert.Released under theMIT License.

This file was generated byverb-generate-readme, v0.6.0, on July 29, 2017.