# packy

> Set default fields in your package.json files.

Latest version **1.2.11** (published 2025-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install packy
pnpm add packy
yarn add packy
bun add packy
```

Provides the command `packy`.

## 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.2.11 |
| Published | 2025-02-14 |
| First published | 2016-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Ionică Bizău |
| Maintainers | ionicabizau |
| Keywords | packy, package.json, npm, default |

## Links

- npm: https://www.npmjs.com/package/packy
- Repository: https://github.com/IonicaBizau/packy
- Homepage: https://github.com/IonicaBizau/packy#readme
- Issues: https://github.com/IonicaBizau/packy/issues
- npm.io page: https://npm.io/package/packy

## Dependencies (9)

- [ul](https://npm.io/package/ul.md) ^5.2.0
- [abs](https://npm.io/package/abs.md) ^1.2.0
- [map-o](https://npm.io/package/map-o.md) ^2.0.0
- [tilda](https://npm.io/package/tilda.md) ^4.2.1
- [r-json](https://npm.io/package/r-json.md) ^1.2.0
- [w-json](https://npm.io/package/w-json.md) ^1.3.0
- [find-value](https://npm.io/package/find-value.md) ^1.0.0
- [emoji-logger](https://npm.io/package/emoji-logger.md) ^1.0.0
- [package-json-path](https://npm.io/package/package-json-path.md) ^1.0.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.11 (latest) — 2025-02-14
- 1.2.10 — 2020-08-09
- 1.2.9 — 2019-01-03
- 1.2.8 — 2017-09-08
- 1.2.7 — 2017-03-23
- 1.2.6 — 2017-03-20
- 1.2.5 — 2016-10-11
- 1.2.4 — 2016-10-11
- 1.2.3 — 2016-05-25
- 1.2.2 — 2016-05-16
- 1.2.1 — 2016-04-26
- 1.2.0 — 2016-04-25
- 1.1.0 — 2016-02-22
- 1.0.0 — 2016-02-04

## README

<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->








[![packy](http://i.imgur.com/fDrtuz7.png)](#)











# `$ packy`

 [![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/packy.svg)](https://www.npmjs.com/package/packy) [![Downloads](https://img.shields.io/npm/dt/packy.svg)](https://www.npmjs.com/package/packy) [![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)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> Set default fields in your package.json files.







This is useful to me especially to autofill my `author` and

`license` fields, so I don't have to type my long name, email

address and website each time when I start a new `npm` package.

Yes, it bumps your productivity! :rocket:













## :cloud: Installation

You can install the package globally and use it as command line tool:


```sh
# Using npm
npm install --global packy

# Using yarn
yarn global add packy
```


Then, run `packy --help` and see what the CLI tool can do.


```
$ packy --help
Usage: packy [options]

Set default fields in your package.json files.

Options:
  -h, --help     Displays this help.
  -v, --version  Displays version information.

Examples:
  $ packy

Make sure the config file is available at ~/.packy.js or ~/pack.json.

Documentation can be found at https://github.com/IonicaBizau/packy#readme.
```







### Configuring `~/.packy.js` or `~/.packy.json`


To make `packy` usable on your machine, you have to create a

file named `packy.js` or `packy.json` in your home directory

(`$HOME` sweet `~` :joy:). :house_with_garden: If you always to override your

`package.json` fields with static data, the `json`format is easier for

you. If you need some dynamic fields (e.g. if the `license` field

from `package.json` contains `GPL`, then return `"GPL-3"`

otherwise return `"MIT"` (see the example below).

It should work for subfields (deep merge) too. :four_leaf_clover:

#### JSON Format (`~/.packy.json`)


My `~/.packy.json` could look like this:

```json
{
    "author": "Ionică Bizău <bizauionica@gmail.com> (http://ionicabizau.net)"
  , "license": "MIT"
}
```

#### JS Format (`~/.packy.js`)


My `~/.packy.js` *looks* like this:

```js
module.exports = {
    author: "Ionică Bizău <bizauionica@gmail.com> (http://ionicabizau.net)"
  , license: function (license) {
       // Few of my projects are licensed under GPL,
       // so don't override the license field
        if (/gpl/i.test(license)) {
            return license;
        }
        return "MIT";
    }
};
```


















## :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

For full API reference, see the [DOCUMENTATION.md][docs] file.












## :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`
 - I developed `packy` to save me some time when having to create
    the `package.json` files. Usually, now, I do `npm init`, without
    filling the `author` and `license` fields (because they are repetitive
    things) and then `packy`. It automagically fills the additional
    fields from my config file (`~/.packy.json`). :sparkling_heart:












## :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/packy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
