# pkgv

> CLI to get the version of a project's package.json

Latest version **1.1.0** (published 2021-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install pkgv
pnpm add pkgv
yarn add pkgv
bun add pkgv
```

Provides the command `pkgv`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-07-07 |
| First published | 2020-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Connor White |
| Maintainers | bconnorwhite |
| Keywords | pkg, package, version, v, get, print, echo, log, cli, project |

## Links

- npm: https://www.npmjs.com/package/pkgv
- Repository: https://github.com/bconnorwhite/pkgv
- Homepage: https://connorwhite.org/github/pkgv
- npm.io page: https://npm.io/package/pkgv

## Dependencies (2)

- [commander-version](https://npm.io/package/commander-version.md) ^2.0.0
- [@bconnorwhite/package](https://npm.io/package/@bconnorwhite/package.md) ^4.3.0

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-07-07
- 1.0.0 — 2020-09-25

## README

<div align="center">
  <h1>pkgv</h1>
  <a href="https://npmjs.com/package/pkgv">
    <img alt="NPM" src="https://img.shields.io/npm/v/pkgv.svg">
  </a>
  <a href="https://github.com/bconnorwhite/pkgv">
    <img alt="TypeScript" src="https://img.shields.io/github/languages/top/bconnorwhite/pkgv.svg">
  </a>
  <a href="https://coveralls.io/github/bconnorwhite/pkgv?branch=master">
    <img alt="Coverage Status" src="https://coveralls.io/repos/github/bconnorwhite/pkgv/badge.svg?branch=master">
  </a>
  <a href="https://github.com/bconnorwhite/pkgv">
    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/bconnorwhite/pkgv?label=Stars%20Appreciated%21&style=social">
  </a>
  <a href="https://twitter.com/bconnorwhite">
    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bconnorwhite.svg?label=%40bconnorwhite&style=social">
  </a>
</div>

<br />

> CLI to get the version of a project's package.json.

## Installation

```sh
yarn add pkgv
```

```sh
npm install pkgv
```

## CLI Usage

```sh
yarn pkgv
```

```sh
npx pkgv
```

## API Usage

```ts
import { getPackageVersion } from "pkgv";

const version = await getPackageVersion();
```

## Types
```ts
import { getPackageVersion } from "pkgv";

function getPackageVersion(): Promise<string | undefined>;
```

<br />

<h2>Dependencies<img align="right" alt="dependencies" src="https://img.shields.io/david/bconnorwhite/pkgv.svg"></h2>

- [@bconnorwhite/package](https://www.npmjs.com/package/@bconnorwhite/package): A utility for reading package.json of a project, and forming paths relative to it.
- [commander-version](https://www.npmjs.com/package/commander-version): A wrapper for Commander that automatically sets the version based on your package.json

<br />

<h2>Dev Dependencies<img align="right" alt="David" src="https://img.shields.io/david/dev/bconnorwhite/pkgv.svg"></h2>

- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs
- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system.  You know, for testing.

<br />

<h2>License <img align="right" alt="license" src="https://img.shields.io/npm/l/pkgv.svg"></h2>

[MIT](https://opensource.org/licenses/MIT)

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