https://github.com/tomodian/vump
A command line utility to simplify your release/changelog management.
https://github.com/tomodian/vump
changeset cli nodejs-library release-management semver typescript
Last synced: 4 days ago
JSON representation
A command line utility to simplify your release/changelog management.
- Host: GitHub
- URL: https://github.com/tomodian/vump
- Owner: tomodian
- Created: 2019-10-07T07:23:16.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2019-12-12T11:01:52.000Z (over 6 years ago)
- Last Synced: 2025-08-09T18:50:30.385Z (7 months ago)
- Topics: changeset, cli, nodejs-library, release-management, semver, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/vump
- Size: 129 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
Awesome Lists containing this project
README
vump
====
CLI tool to manage your CHANGES.md, following semver.
[](https://github.com/tomodian/vump/actions?workflow=Test+on+Linux)
[](https://npmjs.org/package/vump)
[](https://npmjs.org/package/vump)
[](https://github.com/tomodian/vump/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g vump
$ vump COMMAND
running command...
$ vump (-v|--version|version)
vump/0.11.0 darwin-x64 node-v8.10.0
$ vump --help [COMMAND]
USAGE
$ vump COMMAND
...
```
# Commands
* [`vump help [COMMAND]`](#vump-help-command)
* [`vump latest`](#vump-latest)
* [`vump list`](#vump-list)
* [`vump next`](#vump-next)
* [`vump show VERSION`](#vump-show-version)
* [`vump to VERSION`](#vump-to-version)
## `vump help [COMMAND]`
display help for vump
```
USAGE
$ vump 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/v2.2.1/src/commands/help.ts)_
## `vump latest`
Show the latest version of CHANGES.md in the current directory
```
USAGE
$ vump latest
OPTIONS
-h, --help show CLI help
EXAMPLE
$ vump latest
0.1.0
```
_See code: [src/commands/latest.ts](https://github.com/tomodian/vump/blob/v0.11.0/src/commands/latest.ts)_
## `vump list`
Recursively list all the CHANGES.md
```
USAGE
$ vump list
OPTIONS
-h, --help show CLI help
EXAMPLE
$ vump list
examples/CHANGES.md
examples/services/a/CHANGES.md
```
_See code: [src/commands/list.ts](https://github.com/tomodian/vump/blob/v0.11.0/src/commands/list.ts)_
## `vump next`
Show all changes in Next section
```
USAGE
$ vump next
OPTIONS
-f, --format=markdown|slack [default: markdown] Specify output format
-h, --help show CLI help
-o, --only Only show the changes that are included in given version
EXAMPLE
$ vump next
## examples/CHANGES.md
- Feature: This is an example
## examples/services/a/CHANGES.md
(no changes)
```
_See code: [src/commands/next.ts](https://github.com/tomodian/vump/blob/v0.11.0/src/commands/next.ts)_
## `vump show VERSION`
Show previous changes in the given section
```
USAGE
$ vump show VERSION
OPTIONS
-f, --format=markdown|slack [default: markdown] Specify output format
-h, --help show CLI help
-o, --only Only show the changes that are included in given version
EXAMPLE
$ vump show 0.1.0
## examples/CHANGES.md
- Feature: This is an example
## examples/services/a/CHANGES.md
(no changes)
```
_See code: [src/commands/show.ts](https://github.com/tomodian/vump/blob/v0.11.0/src/commands/show.ts)_
## `vump to VERSION`
Bump to the given version
```
USAGE
$ vump to VERSION
OPTIONS
-h, --help show CLI help
EXAMPLE
$ vump to 0.1.0
```
_See code: [src/commands/to.ts](https://github.com/tomodian/vump/blob/v0.11.0/src/commands/to.ts)_