# relper-cli

> Release helper cli to help/assist with the release flow.

Latest version **0.2.1** (published 2021-04-26) · MIT license · 0 weekly downloads

## Install

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

Provides the command `relper`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-04-26 |
| First published | 2021-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 11 |
| Unpacked size | 64.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Eduardo Azevedo Grigolo |
| Maintainers | azedo |
| Keywords | oclif, relper, cli, release |

## Links

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

## Dependencies (11)

- [ora](https://npm.io/package/ora.md) ^5.1.0
- [rxjs](https://npm.io/package/rxjs.md) ^6.6.3
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [tslib](https://npm.io/package/tslib.md) ^2.0.3
- [pkg-dir](https://npm.io/package/pkg-dir.md) ^4.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [module-alias](https://npm.io/package/module-alias.md) ^2.2.2
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.17.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.8.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2021-04-26
- 0.2.0 — 2021-04-21
- 0.1.0 — 2021-04-19
- 0.0.1 — 2021-04-19

## README

# Relper CLI

Command-line interface to help/assist with the release process.

(\*_with some opinions_)

[![Version](https://img.shields.io/npm/v/relper-cli.svg)](https://npmjs.org/package/relper-cli)
[![Downloads/week](https://img.shields.io/npm/dw/relper-cli.svg)](https://npmjs.org/package/relper-cli)
[![License](https://img.shields.io/npm/l/relper-cli.svg)](https://github.com/azedo/relper-cli/blob/master/package.json)
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=alert_status)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=bugs)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=code_smells)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=azedo_relper-cli&metric=sqale_index)](https://sonarcloud.io/dashboard?id=azedo_relper-cli)

<!-- toc -->
* [Relper CLI](#relper-cli)
<!-- tocstop -->

## Usage

<!-- usage -->
```sh-session
$ npm install -g relper-cli
$ relper COMMAND
running command...
$ relper (-v|--version|version)
relper-cli/0.2.1 linux-x64 node-v12.22.1
$ relper --help [COMMAND]
USAGE
  $ relper COMMAND
...
```
<!-- usagestop -->

## Commands

<!-- commands -->
* [`relper create:changelog`](#relper-createchangelog)
* [`relper create:config`](#relper-createconfig)
* [`relper help [COMMAND]`](#relper-help-command)
* [`relper version:bump`](#relper-versionbump)
* [`relper version:get`](#relper-versionget)

## `relper create:changelog`

```
USAGE
  $ relper create:changelog

OPTIONS
  -f, --force    force replace action
  -h, --help     show CLI help
  -r, --replace  replace CHANGELOG
  -s, --silent   don't show any logs
```

_See code: [src/commands/create/changelog.ts](https://github.com/azedo/relper-cli/blob/v0.2.1/src/commands/create/changelog.ts)_

## `relper create:config`

```
USAGE
  $ relper create:config

OPTIONS
  -f, --force        force replace action
  -h, --help         show CLI help
  -i, --interactive  interactive config creator
  -r, --replace      replace relper config
  -s, --silent       don't show any logs
```

_See code: [src/commands/create/config.ts](https://github.com/azedo/relper-cli/blob/v0.2.1/src/commands/create/config.ts)_

## `relper help [COMMAND]`

```
USAGE
  $ relper help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `relper version:bump`

```
USAGE
  $ relper version:bump

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  new version
```

_See code: [src/commands/version/bump.ts](https://github.com/azedo/relper-cli/blob/v0.2.1/src/commands/version/bump.ts)_

## `relper version:get`

```
USAGE
  $ relper version:get

OPTIONS
  -h, --help                   show CLI help
  -p, --folderPath=folderPath  the project's main folder
  -s, --silent                 return silent
```

_See code: [src/commands/version/get.ts](https://github.com/azedo/relper-cli/blob/v0.2.1/src/commands/version/get.ts)_
<!-- commandsstop -->

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