Skip to content

super-bunny/pld-cli

Repository files navigation

PLD CLI

Last commit NPM Version Dependencies status

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

About

CLI that groups some utilities for PLD files 🔧

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages