@gld5000-cli/npm-init

A CLI app to update your package.json and README.md ready for publishing on NPM

Install

npm i -D @gld5000-cli/npm-init

Example Usage

Import (.mjs)

import * as npmInit from '@gld5000-cli/npm-init'

Example Input

npx @gld5000-cli/npm-init

Example Output

This utility will walk you through creating a README.md file for your NPM package.

It only covers some useful items, and uses your package.json to generate defaults.

Press ^C at any time to quit.


Replace existing README (or append)?: (y) n
Header: (# [@gld5000-cli/npm-init](https://www.npmjs.com/package/@gld5000-cli/npm-init))
Install: (npm i -D @gld5000-cli/npm-init)
Import: (import * as npmInit from '@gld5000-cli/npm-init')

Update

npm update @gld5000-cli/npm-init

Uninstall

npm uninstall @gld5000-cli/npm-init

Execute Directly from NPM

npx @gld5000-cli/npm-init

License

MIT License

Copyright (c) 2025 Gareth L Devlin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.