https://github.com/jceb/semver-compare-cli
CLI wrapper of the semver-compare library
https://github.com/jceb/semver-compare-cli
cli semver semver-compare semver-parser
Last synced: 25 days ago
JSON representation
CLI wrapper of the semver-compare library
- Host: GitHub
- URL: https://github.com/jceb/semver-compare-cli
- Owner: jceb
- License: mit
- Created: 2021-03-06T17:30:32.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-03T12:57:10.000Z (almost 4 years ago)
- Last Synced: 2025-03-30T02:33:45.526Z (28 days ago)
- Topics: cli, semver, semver-compare, semver-parser
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/semver-compare-cli
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# semver-compare-cli
[](https://github.com/RichardLitt/standard-readme)
CLI wrapper of the semver-compare library
Compare two semver version strings on the command line. The exit code is 0
(equal), 1 (greater), or 2 (smaller). In addition, a predicate can be added
that's applied when comparing the two version.
The project is a wrapper around the
[semver-compare](https://github.com/substack/semver-compare) library.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Install
Install via npm:
```
yarn global add semver-compare-cli
```
or use [deno](https://deno.land) to run it without installation:
```
deno run https://cdn.deno.land/semver_compare_cli/versions/v2.0.0/raw/semver-compare.js
```
## Usage
### Direct comparison
For a direct comparison of two versions the following exit codes are possible:
- `0` versions are equal
- `1` the first version is larger than the second version
- `2` the first version is smaller than the second version
Example, exit code is `2` because the first version is smaller than the second
version:
```
semver-compare 1.0.0 1.0.1
```
### Comparison with predicate
For a comparison with a predicate the following exit codes are possible:
- `0` predicate applies to the comparison of the two version
- `1` predicate doesn't apply
The following predicates are supported that shall be placed between the
two version numbers:
- `eq`: equal
- `ge`: greater than or equal
- `gt`: greater than
- `le`: lower than or equal
- `lt`: lower than
Example, exit code is `1` because the first version is smaller than the second
version:
```
semver-compare 1.0.0 ge 1.0.1
```
## Maintainers
[@jceb](https://github.com/jceb)
## Contributing
PRs accepted.
Small note: If editing the README, please conform to the
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
MIT © 2021 Jan Christoph Ebersbach