0.2.0 ā€¢ Published 3 years ago

pld-cli v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

PLD CLI

Last commit NPM Version Dependencies status Install size

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

āš  PLD files must respect this JSON schema: 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:

npm install -g pld-cli

With yarn:

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