Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.57 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.57 KB

pdq

A utility for dealing with PlainData files.

PlainData is a format focused on a plaintext description and a list of data sections each containing either more plaintext or some set of data (often in csv or similar).

See plaindata.md for more details on the format.

Installation

  1. $ shards build
  2. cp bin/pdq ~/bin (or somewhere else in your path)

Usage

usage: pdq SUBCOMMAND [ARGS] FILE

subcommands:
  version             prints pdq's version
  help                prints this help
  description NAME    prints the description section in FILE
  list                lists the sections available for querying in FILE
  read NAME           prints the contents of the section NAME in FILE
  append NAME [OPT]   appends STDIN to the section NAME of the FILE
  run [NAME]          executes the section NAME as if it were a script    *
                          if NAME is not provided, "Script" is used       *
                          if section NAME is not found, pqd returns 1     *

append options:
  -f, --force         add a new section at the end if it was not found    *
  -n, --no-newline    avoid a blank line between sections                 *


* Feature is not implemented yet.

Contributing

  1. Fork it (https://github.com/Willamin/pdq/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors