generate-verbfile

generate-verbfile

Generate a verbfile.js in the current working directory or specified --dest.

Table of Contents

• What is "Generate"?
• Command line usage
  • Install
  • Run
  • Help
• Next steps
• About

(TOC generated by verb using markdown-toc)

What is "Generate"?

Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks. Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.

For more information about Generate:

• Visit the generate project
• Visit the generate documentation
• Find generators on npm (help us author generators)

Command line usage

Install

Installing the CLI

To run the verbfile 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 generate-verbfile

You may now install this module with the following command:

$ npm install --global generate-verbfile

Run

You should now be able to run generate-verbfile with the following command:

$ gen verbfile

What will happen?

Running $ gen verbfile will run the generator's default task, which will:

• prompt you for any information that's missing
• render the necessary template(s) using your answers
• write the resulting files to the current working directory

What you should see in the terminal

If completed successfully, you should see both starting and 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.

Help

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

$ gen help

Next steps

• docs.md: additional documentation for this generator
• Generate documentation: visit the Generate docs
• Generate repo: visit the Generate repository

About

Related projects

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
• update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

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

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on July 15, 2016.