# pld-cli

> [![Last commit](https://img.shields.io/github/last-commit/super-bunny/pld-cli/dev)](https://github.com/super-bunny/pld-cli/tree/dev) [![NPM Version](http://img.shields.io/npm/v/pld-cli?style=flat)](https://www.npmjs.org/package/pld-cli) [![Dependencies st

Latest version **0.2.0** (published 2021-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install pld-cli
pnpm add pld-cli
yarn add pld-cli
bun add pld-cli
```

Provides the command `pld`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-04-26 |
| First published | 2021-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=15 |
| Dependencies | 10 |
| Unpacked size | 88.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Clovis de Villars |
| Maintainers | super-bunny |
| Keywords | cli, pld, pld-cli, project log, project log document, json-pld, pld-json-schema |

## Links

- npm: https://www.npmjs.com/package/pld-cli
- Repository: https://github.com/super-bunny/pld-cli
- Homepage: https://github.com/super-bunny/pld-cli#readme
- Issues: https://github.com/super-bunny/pld-cli/issues
- npm.io page: https://npm.io/package/pld-cli

## Dependencies (10)

- [ora](https://npm.io/package/ora.md) ^5.3.0
- [boxen](https://npm.io/package/boxen.md) ^5.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [figures](https://npm.io/package/figures.md) ^3.2.0
- [fuse.js](https://npm.io/package/fuse.js.md) ^6.4.6
- [commander](https://npm.io/package/commander.md) ^7.1.0
- [typescript-is](https://npm.io/package/typescript-is.md) ^0.18.1
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0
- [compare-versions](https://npm.io/package/compare-versions.md) ^3.6.0
- [console-table-printer](https://npm.io/package/console-table-printer.md) ^2.8.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2021-04-26
- 0.3.0-alpha.3 (next) — 2021-05-22
- 0.3.0-alpha.2 — 2021-05-22
- 0.3.0-alpha.1 — 2021-05-20
- 0.1.0 — 2021-03-24

## README

# PLD CLI

[![Last commit](https://img.shields.io/github/last-commit/super-bunny/pld-cli/dev)](https://github.com/super-bunny/pld-cli/tree/dev)
[![NPM Version](http://img.shields.io/npm/v/pld-cli?style=flat)](https://www.npmjs.org/package/pld-cli)
[![Dependencies status](https://img.shields.io/david/super-bunny/pld-cli)](https://david-dm.org/super-bunny/pld-cli)

CLI that groups some utilities for PLD (Project Log Document) files.

⚠ PLD files must respect this JSON schema: [super-bunny/pld-json-schema](https://github.com/super-bunny/pld-json-schema).

## Features

- 🔎 Auto search PLD file in the current directory (or specified one)
- 🧰 Utility commands (version getter, work time distribution ...)
- 🏷 User story filters and search
- ✨ Pretty colored command output
- 📜 Script mode for easily parse command output \
  (will print command output in JSON and disable extra message logs)

## Installation

With npm:

```bash
npm install -g pld-cli
```

With yarn:

```bash
yarn global add pld-cli
```

## Usage

```
$ pld -h

Usage: pld [options] [command]

Command line utility for pld file

Options:
  -V, --version                  output the version number
  -f, --file <pld_file_path>     pld file the cli will use
  -d, --dir <pld_dir_path>       directory where cli will search for pld file
  --script                       will print command outputs in JSON and without any logs
  -h, --help                     display help for command

Commands:
  version                        get pld latest version number
  duration                       get estimated duration sum of pld user stories
  assignees [options] <user...>  list user stories assigned to specified user
  distribution                   get user stories duration distribution
  user-story|us                  user stories related commands
  help [command]                 display help for command
```

### [Commands](docs/commands.md)

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