# nuncio-cli

> Nuncio is a command-line tool for keeping your GIT repositories and NPM projects updated

Latest version **1.4.0** (published 2020-06-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install nuncio-cli
pnpm add nuncio-cli
yarn add nuncio-cli
bun add nuncio-cli
```

Provides the command `nuncio`.

## 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 | 1.4.0 |
| Published | 2020-06-12 |
| First published | 2020-06-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Victor Ferreira |
| Maintainers | porta8080 |
| Keywords | pipeline, ci, cd, versioning, tooling |

## Links

- npm: https://www.npmjs.com/package/nuncio-cli
- Repository: https://github.com/victorsferreira/nuncio-cli
- Homepage: https://github.com/victorsferreira/nuncio-cli#readme
- Issues: https://github.com/victorsferreira/nuncio-cli/issues
- npm.io page: https://npm.io/package/nuncio-cli

## Dependencies (2)

- [execa](https://npm.io/package/execa.md) ^4.0.2
- [yargs](https://npm.io/package/yargs.md) ^15.3.1

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2020-06-12
- 1.2.5 — 2020-06-09
- 1.2.4 — 2020-06-09
- 2.0.0 — 2020-06-09
- 1.2.3 — 2020-06-09
- 1.2.2 — 2020-06-09
- 1.1.2 — 2020-06-07
- 2.1.0 — 2020-06-07
- 1.1.0 — 2020-06-07
- 1.0.0 — 2020-06-06

## README

# Nuncio

Nuncio is a command-line tool for keeping your GIT repositories and NPM projects updated.

Nuncio is ideal for CI and CD environments.


### Pre-requisites

Besides Node and NPM, of course, Nuncio expects you to have GIT installled in the environment. 


### Usage

Install **nuncio** as part of your project or globally

```
$ npm install --global nuncio
$ npm install --save-dev nuncio
```

By default, **nuncio** will checkout and commit in the `master` branch.

You can pass one of the three *semver* options `major`, `minor` or `patch`. Default is `major`.

You can define the `remote` alias that defaults to `origin`.

The commit and tag messages can be set with the `message` parameter.

```
$ nuncio -s major -r origin -b master
```

You can also pass `--npm` flag to deploy the version to you NPM registry.

```
$ nuncio --npm
```


### What does it do

Assuming a NPM library with the version `1.0.0`, the following command

```
$ nuncio -s minor -r origin -b master -p "v" -m "A new feature was added" --npm
```

Will result in:

- Nuncio will checkout to the `master` branch
- It will update the NPM version to `1.1.0`
- Adds the `package.json` file to the index and commits with the a message in the pattern `chore: 1.1.0 - A new feature was added`
- Creates an annotated tag with name `v1.1.0` and message `A new feature was added`
- Nuncio will push current commit and the newly created tag to `origin`
- Finally it publishes the source code to NPM
- Nuncio will try to rollback all completed steps if it finds and an error


### Reference

| **Command** | **Description**                                         | **Default** | **Alias** |
|-------------|---------------------------------------------------------|-------------|-----------|
| `branch`    | Sets the branch to which Nuncio must commit             | *master*    | `b`       |
| `semver`    | Tells Nuncio the version segment it must increase       | *major*     | `s`       |
| `remote`    | The remote branch to which Nuncio will push the changes | *origin*    | `r`       |
| `message`   | Defines the commit and tag message                      | none        | `m`       |
| `prefix`    | Sets the prefix of the tag name                         | *v*         | `p`       |
| `npm`       | This flag defines whether Nuncio must publish to NPM    | *false*     | none      |

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