# np-init > Easily start a npm package from scratch. Latest version **1.0.10** (published 2025-02-14) · MIT license · 0 weekly downloads ## Install ```sh npm install np-init pnpm add np-init yarn add np-init bun add np-init ``` ## Health **Score 25/100 (F)** — status: maintenance-mode. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.10 | | Published | 2025-02-14 | | First published | 2016-04-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 14 | | Unpacked size | 12.7 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 2 | | Author | Ionică Bizău | | Maintainers | ionicabizau | | Keywords | npm, package, init | ## Links - npm: https://www.npmjs.com/package/np-init - Repository: https://github.com/IonicaBizau/np-init - Homepage: https://github.com/IonicaBizau/np-init#readme - Issues: https://github.com/IonicaBizau/np-init/issues - npm.io page: https://npm.io/package/np-init ## Dependencies (14) - [ul](https://npm.io/package/ul.md) ^5.2.1 - [abs](https://npm.io/package/abs.md) ^1.2.1 - [gry](https://npm.io/package/gry.md) ^5.0.0 - [packy](https://npm.io/package/packy.md) ^1.0.0 - [r-json](https://npm.io/package/r-json.md) ^1.2.1 - [worder](https://npm.io/package/worder.md) ^1.0.1 - [streamp](https://npm.io/package/streamp.md) ^2.2.1 - [fullname](https://npm.io/package/fullname.md) ^3.0.0 - [find-value](https://npm.io/package/find-value.md) ^1.0.1 - [one-by-one](https://npm.io/package/one-by-one.md) ^3.1.0 - [array-unique](https://npm.io/package/array-unique.md) ^0.2.1 - [js-templates](https://npm.io/package/js-templates.md) ^1.0.1 - [w-package-json](https://npm.io/package/w-package-json.md) ^1.0.0 - [package-json-path](https://npm.io/package/package-json-path.md) ^1.0.0 ## Recent versions - 1.0.10 (latest) — 2025-02-14 - 1.0.9 — 2020-08-09 - 1.0.8 — 2019-01-03 - 1.0.7 — 2017-09-08 - 1.0.6 — 2017-03-23 - 1.0.5 — 2017-03-20 - 1.0.4 — 2016-10-11 - 1.0.3 — 2016-10-11 - 1.0.2 — 2016-05-25 - 1.0.1 — 2016-04-26 - 1.0.0 — 2016-04-12 ## README # np-init [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/np-init.svg)](https://www.npmjs.com/package/np-init) [![Downloads](https://img.shields.io/npm/dt/np-init.svg)](https://www.npmjs.com/package/np-init) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) Buy Me A Coffee > Easily start a npm package from scratch. ## :cloud: Installation ```sh # Using npm npm install --save np-init # Using yarn yarn add np-init ``` :bulb: **ProTip**: You can install the [cli version of this module](https://github.com/IonicaBizau/np-init-cli) by running `npm install --global np-init-cli` (or `yarn global add np-init-cli`). ## :clipboard: Example ```js const init = require("np-init"); init({ name: "foo" , description: "This is a test package" , dirname: `${__dirname}/result` }, (err, data) => { console.log(err || data); }); // $ tree result // result/ // ├── example // │   └── index.js // ├── lib // │   └── index.js // └── package.json // 2 directories, 3 files ``` ## :question: Get Help There are few ways to get help: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation ### `init(options, callback)` Inits a new `npm` package. #### Params - **Object** `options`: An object containing the following fields: - `name` (String): The package name. This is **required**. - `template` (String): The template name to be used (check out [`js-templates`](https://github.com/IonicaBizau/js-templates)). Defaults to `function-export`. - `exampleFile` (String): The example file path (default: `example/index.js`). - `exampleTemplate` (String): The example template (default: `"example"`). - `description` (String): The package description. - `dirname` (String): The path to the directory where to create the project (default: the current directory). - `pack` (Object): The `package.json` information. - **Function** `callback`: The callback function. #### Return - **EventEmitter** An event emitter emitting the following events: - `repo_created` (data): After the repository was created. - `package_written` (data): After the package.json was written. - `packy_done` (data): After the defaults in `package.json` were set. Note you can do this using [`packy`](https://github.com/IonicaBizau/packy). - `after_init_handler` (data): After the `afterinit` handler was executed. - `git_add` (data): After `git add .` was executed. - `git_commit` (data): After `git commit ...` was executed. - `git_remote_add` (data): After `git remote add ...` was executed. ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: Support my projects I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: - Starring and sharing the projects you like :rocket: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` ![](https://i.imgur.com/z6OQI95.png) Thanks! :heart: ## :dizzy: Where is this library used? If you are using this library in one of your projects, add it in this list. :sparkles: - `np-init-cli` ## :scroll: License [MIT][license] © [Ionică Bizău][website] [license]: /LICENSE [website]: https://ionicabizau.net [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW --- _Source: https://npm.io/package/np-init · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._