# generator-node
> Create a Node.js module
Latest version **2.9.0** (published 2025-11-01) · MIT license · 0 weekly downloads
## Install
```sh
npm install generator-node
pnpm add generator-node
yarn add generator-node
bun add generator-node
```
## Health
**Score 45/100 (D)** — status: stable.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
## Facts
| | |
|---|---|
| Version | 2.9.0 |
| Published | 2025-11-01 |
| First published | 2013-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 31.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 579 |
| Author | Yeoman team |
| Maintainers | sboudrias, mischah, ulisesgascon, mshima, joshuakgoldberg, eddiemonge, sindresorhus, kevva, addyosmani |
| Keywords | yeoman-generator, scaffold, node, module, cli |
## Links
- npm: https://www.npmjs.com/package/generator-node
- Repository: https://github.com/yeoman/generator-node
- Issues: https://github.com/yeoman/generator-node/issues
- npm.io page: https://npm.io/package/generator-node
## Dependencies (11)
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [parse-author](https://npm.io/package/parse-author.md) ^2.0.0
- [generator-jest](https://npm.io/package/generator-jest.md) ^1.7.0
- [github-username](https://npm.io/package/github-username.md) ^5.0.1
- [generator-travis](https://npm.io/package/generator-travis.md) ^1.9.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^4.2.0
- [generator-license](https://npm.io/package/generator-license.md) ^5.2.0
- [inquirer-npm-name](https://npm.io/package/inquirer-npm-name.md) ^3.0.0
- [git-remote-origin-url](https://npm.io/package/git-remote-origin-url.md) ^3.0.0
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0
## Alternatives
- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads
## Recent versions
- 2.9.0 (latest) — 2025-11-01
- 2.8.0 — 2019-11-17
- 2.7.0 — 2019-07-21
- 2.6.0 — 2018-11-22
- 2.5.0 — 2018-08-27
- 2.4.1 — 2018-04-30
- 2.4.0 — 2018-03-27
- 2.3.0 — 2017-09-28
- 2.2.0 — 2017-06-25
- 2.1.0 — 2017-04-02
- 2.0.1 — 2017-03-25
- 2.0.0 — 2017-03-24
- 1.12.1 — 2016-10-18
- 1.12.0 — 2016-10-18
- 1.11.0 — 2016-07-24
- … 42 more at https://npm.io/package/generator-node/versions
## README
# Node Generator [](https://github.com/yeoman/generator-node/actions/workflows/ci.yml) [](https://gitter.im/yeoman/yeoman) [](https://opencollective.com/yeoman#support)
`generator-node` creates a base template to start a new Node.js module.
It is also easily composed into your own generators so you can only target your efforts at your generator's specific features.
## Install
```
$ npm install --global generator-node
```
## Usage
```
$ yo node
```
*Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.*
That'll generate a project with all the common tools setup. This includes:
- Filled `package.json` file
- [jest](https://facebook.github.io/jest/) unit test and code coverage (optionally tracked on [Coveralls](https://coveralls.io/))
- [ESLint](http://eslint.org/) linting and code style checking
- [Travis CI](https://travis-ci.com/) continuous integration (optional)
- [License](https://spdx.org/licenses/)
### Running tests
Once the project is scaffolded, inside the project folder run:
```
$ npm test
```
You can also directly use jest to run test on single files:
```
$ npm -g install jest-cli
$ jest --watch
```
### Publishing your code
Once your tests are passing (ideally with a Travis CI green run), you might be ready to publish your code to npm. We recommend you using [npm version](https://docs.npmjs.com/cli/version) to tag release correctly.
```
$ npm version major
$ git push --follow-tags
# ATTENTION: There is no turning back here.
$ npm publish
```
## Extend this generator
First of all, make sure you're comfortable with [Yeoman composability](http://yeoman.io/authoring/composability.html) feature. Then in your own generator:
```js
var Generator = require('yeoman-generator');
module.exports = class extends Generator({
default() {
this.composeWith(require.resolve('generator-node/generators/app'), {
/* provide the options you want */
});
}
});
```
### Options
Here's a list of our supported options:
- `boilerplate` (Boolean, default true) include or not the boilerplate files (`lib/index.js`, `test/index.js`).
- `cli` (Boolean, default false) include or not a `lib/cli.js` file.
- `editorconfig` (Boolean, default true) include or not a `.editorconfig` file.
- `git` (Boolean, default true) include or not the git files (`.gitattributes`, `.gitignore`).
- `license` (Boolean, default true) include or not a `LICENSE` file.
- `travis` (Boolean, default true) include or not a `.travis.yml` file.
- `githubAccount` (String) Account name for GitHub repo location.
- `readme` (String) content of the `README.md` file. Given this option, generator-node will still generate the title (with badges) and the license section.
### Sub generators
If you don't need all the features provided by the main generator, you can still use a limited set of features by composing with our sub generators directly.
Remember you can see the options of each sub generators by running `yo node:sub --help`.
- `node:boilerplate`
- `node:cli`
- `node:editorconfig`
- `node:eslint`
- `node:git`
- `node:readme`
## Backers
Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[[Become a backer](https://opencollective.com/yeoman#support)]
## License
MIT © Yeoman team (http://yeoman.io)
---
_Source: https://npm.io/package/generator-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._