# versionup

> Increment version number in package.json (or bower.json)

Latest version **3.0.4** (published 2019-05-01) · MIT license · 0 weekly downloads

## Install

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

Provides the command `versionup`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.4 |
| Published | 2019-05-01 |
| First published | 2015-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 38.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | package.json, bower.json, project, automation |

## Links

- npm: https://www.npmjs.com/package/versionup
- Repository: https://github.com/okunishinishi/node-versionup
- Homepage: https://github.com/okunishinishi/node-versionup#readme
- Issues: https://github.com/okunishinishi/node-versionup/issues
- npm.io page: https://npm.io/package/versionup

## Dependencies (2)

- [argx](https://npm.io/package/argx.md) ^4.0.0
- [commander](https://npm.io/package/commander.md) ^2.20.0

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

- 3.0.4 (latest) — 2019-05-01
- 3.0.3 — 2019-02-23
- 3.0.2 — 2018-10-31
- 2.1.2 — 2016-09-13
- 2.1.1 — 2016-09-13
- 2.1.0 — 2016-09-12
- 2.0.3 — 2016-09-12
- 2.0.2 — 2016-07-30
- 2.0.1 — 2016-05-11
- 2.0.0 — 2016-05-11
- 1.3.0 — 2015-10-27
- 1.2.3 — 2015-09-19
- 1.2.1 — 2015-09-19
- 1.2.0 — 2015-09-13
- 1.1.1 — 2015-08-08
- … 10 more at https://npm.io/package/versionup/versions

## README

versionup
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-versionup
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-versionup
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-versionup.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-versionup
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-versionup.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-versionup/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-versionup
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-versionup.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-versionup.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-versionup
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-versionup.svg
[bd_npm_url]: http://www.npmjs.org/package/versionup
[bd_npm_shield_url]: http://img.shields.io/npm/v/versionup.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Increment version number in package.json (or bower.json)

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
npm install versionup --save-dev
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
----

Call `versionup()` at project root path where `package.json` exists.

Version number will be incremented. (eg. `{"version" : "1.0.0}` -> `{"version" : "1.0.1}`)

```javascript
#!/usr/bin/env node

/**
 * This is an example to use versionup.
 */

'use strict'

const versionup = require('versionup')

// Increment version number in package.json (or bower.json).
versionup({
  // Options
}).then(() => {
  /* ... */
})

````


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Options.md.hbs" Start -->

<a name="section-doc-guides-03-options-md"></a>

Options
---------

| Key | Default | Description |
| --- | --- | --- |
| path | process.cwd() | Project root path or json file path to work with |
| level | 'patch' | Level to change. "major", "minor", or "patch". |
| amount | 1 | Amount to increment. |


<!-- Section from "doc/guides/03.Options.md.hbs" End -->

<!-- Section from "doc/guides/04.CLI.md.hbs" Start -->

<a name="section-doc-guides-04-cli-md"></a>

Using with CLI
---------

Install as a global module.

```bash
$ npm install versionup -g
```

Then,

```bash
$ versionup -p "~/my_project" -l "micro" -a "1"
```



<!-- Section from "doc/guides/04.CLI.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-versionup/blob/master/LICENSE).

<!-- LICENSE End -->

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