# npm-initer

> Initialize NPM package.

Latest version **0.1.8** (published 2018-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-initer
pnpm add npm-initer
yarn add npm-initer
bun add npm-initer
```

Provides the command `npm-init`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2018-01-25 |
| First published | 2018-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | wolfram77@gmail.com |
| Maintainers | wolfram77 |
| Keywords | npm, init, initer |

## Links

- npm: https://www.npmjs.com/package/npm-initer
- npm.io page: https://npm.io/package/npm-initer

## Dependencies (2)

- [object-fromtext](https://npm.io/package/object-fromtext.md) ^0.1.1
- [string-mapreplace](https://npm.io/package/string-mapreplace.md) ^0.1.4

## Recent versions

- 0.1.8 (latest) — 2018-01-25
- 0.1.7 — 2018-01-25
- 0.1.6 — 2018-01-25
- 0.1.5 — 2018-01-25
- 0.1.4 — 2018-01-25
- 0.1.3 — 2018-01-25
- 0.1.2 — 2018-01-25
- 0.1.1 — 2018-01-25
- 0.1.0 — 2018-01-25
- 0.0.10 — 2018-01-25
- 0.0.9 — 2018-01-25
- 0.0.8 — 2018-01-25
- 0.0.7 — 2018-01-25
- 0.0.6 — 2018-01-25
- 0.0.5 — 2018-01-25
- … 4 more at https://npm.io/package/npm-initer/versions

## README

# npm-initer

[![NPM](https://nodei.co/npm/npm-initer.png)](https://nodei.co/npm/npm-initer/)

Initialize NPM package.
> [npm-cloner] can be used for cloning to [GitHub].<br>
> [npm-push] can be used to publish changes.

```bash
npm-init [flags] [description]
# [description]: description of package
# [-n|--name]: name of package (<directory name>)
# [-v|--version]: version of package (0.0.0)
# [-m|--main]: main file of package (index.js)
# [-s|--scripts]: scripts of package (test=exit)
# [-k|--keywords]: keywords of package (expect,us)
# [-a|--author]: author of package (anonymous)
# [-l|--license]: license of package (MIT)
# [--links]: readme links of package
# [--index]: index.js template of package
# [--index-file]: index.js template file of package
# [--readme]: README.md template of package
# [--readme-file]: README.md template file of package
# [--help]: show help 
# [[optional environment variables]]
# NPM_INIT_NAME: name of package (<directory name>)
# NPM_INIT_VERSION: version of package (0.0.0)
# NPM_INIT_DESCRIPTION: description of package
# NPM_INIT_MAIN: main file of package (index.js)
# NPM_INIT_SCRIPTS: scripts of package (test=exit)
# NPM_INIT_KEYWORDS: keywords of package (expect,us)
# NPM_INIT_AUTHOR: author of package (anonymous)
# NPM_INIT_LICENSE: license of package (MIT)
# NPM_INIT_LINKS: readme links of package
# NPM_INIT_INDEX: index.js template of package
# NPM_INIT_INDEX_FILE: index.js template file of package
# NPM_INIT_README: README.md temple of package
# NPM_INIT_README_FILE: README.md template file of package

cd alpha-go
npm-init "Lets defeat Go players" --keywords "alpha,go"
# "alpha-go@0.0.0" created

cd alpha-go
NPM_INIT_LINKS="Alpha=https://abc.xyz;Go=https://en.wikipedia.org/wiki/Go_(game)"
NPM_INIT_INDEX="function \${name}() {\n};\nmodule.exports = \${name};\n"
NPM_INIT_README="# \${name}\n\${description}\n"
npm-init "Lets defeat Go players" -k "alpha,go" --version "0.0.1"
# "alpha-go@0.0.1" created
# index.js:
# - function alpha-go() {
# - };
# - module.exports = aplha-go;
# README.md:
# - # alpha-go
# - Lets defeat [Go] players
# - 
# - 
# - [Go]: https://en.wikipedia.org/wiki/Go_(game)

cd alpha-go
NPM_INIT_LINKS="Alpha=https://abc.xyz;Go=https://en.wikipedia.org/wiki/Go_(game)"
NPM_INIT_INDEX_FILE="/home/index.js.template"
NPM_INIT_README_FILE="/home/README.md.template"
npm-init "Lets defeat Go players" -k "alpha,go" -v "0.0.1"
# /home/index.js.template:
# - function ${name} {};
# /home/README.md.template:
# - # ${name}
# - 
# - ${description}.
# - 
# - ```javascript
# - const ${name} = require('${name}');
# - // ${name}(...)
# - ```
# "alpha-go@0.0.1" created
# index.js:
# - function alpha-go() {};
# README.md:
# - # alpha-go
# - 
# - Lets defeat [Go] players.
# - 
# - ```javascript
# - const alpha-go = require('alpha-go');
# - // alpha-go(...)
# - ```
# - 
# - 
# - [Go]: https://en.wikipedia.org/wiki/Go_(game)
```


[GitHub]: https://github.com/
[npm-cloner]: https://www.npmjs.com/package/npm-cloner
[npm-push]: https://www.npmjs.com/package/npm-push

---
_Source: https://npm.io/package/npm-initer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._