https://github.com/azedo/relper-cli

Command-line interface to help/assist with the release process. (*with some opinions)
https://github.com/azedo/relper-cli

cli git oclif release typescript

Last synced: 11 days ago
JSON representation

Command-line interface to help/assist with the release process. (*with some opinions)

• Host: GitHub
• URL: https://github.com/azedo/relper-cli
• Owner: azedo
• Created: 2021-04-10T06:26:39.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-17T03:36:22.000Z (over 2 years ago)
• Last Synced: 2025-10-27T16:04:29.108Z (8 months ago)
• Topics: cli, git, oclif, release, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/relper-cli
• Size: 605 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

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)

* [Relper CLI](#relper-cli)

## Usage

```sh-session

$ npm install -g relper-cli

$ relper COMMAND

running command...

$ relper (-v|--version|version)

relper-cli/0.2.1 darwin-x64 node-v12.18.3

$ relper --help [COMMAND]

USAGE

  $ relper COMMAND

...

```

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