An open API service indexing awesome lists of open source software.

https://github.com/dylarcher/verman-cli

A CLI library for managing node/npm versions range engine limits.
https://github.com/dylarcher/verman-cli

cli command-line compatibility limits maximum minimum nodejs npm range support tool versions

Last synced: 5 months ago
JSON representation

A CLI library for managing node/npm versions range engine limits.

Awesome Lists containing this project

README

          

# `verman-cli`

`verman-cli` is a CLI tool for collecting and analyzing Node.js version compatibility from your project's dependencies, as specified in `package.json` and lockfiles.

## Installation

```bash
npm install -g verman-cli
# or
# yarn global add verman
```

You can also use it directly with npx:

```bash
npx verman-cli [project_path] [options]
```

## Usage

```bash
verman-cli [path_to_your_project] [options]
```

**Arguments:**

* `project_path` (optional): Path to the project directory. Defaults to the current working directory.

**Options:**

* `-V, --version`: Output the version number.
* `--include-dev`: Include devDependencies in the analysis.
* `--json`: Output results in JSON format.
* `-h, --help`: Display help for command.

## Features (MVP)

* Analyzes `package.json` from the root project.
* Parses `package-lock.json` (v2/v3 recommended for richer data) and `npm-shrinkwrap.json`.
* Calculates an overall recommended Node.js version range.
* Lists individual `engines.node` constraints found.
* JSON output for programmatic use.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

MIT