Brown Dog Command-Line Interface (BD-CLI)
=========================================

bd [OPTION] [FILE/DIRECTORY]
-----------------------------

Command line interface to Brown Dog services. Use to convert files between formats and extract various derived products
from file contents (e.g. tags, metadata, signatures, previews).

-b set the BD URL (e.g. https://bd-api.ncsa.illinois.edu)

-t set the token

-v verbose output

-w set wait time for conversions/extractions

-h display help

-o set output format

-e extractor name

-p parameter key value pair

--outputs list the available output formats for the given file

--extractors list the available extractors for the given file

--find search current directory for a file similar to the given file

--bigdata use this flag if the file is large enough and it needs to be processed locally rather than using remote
 Brown Dog services

 **Examples:**

List available output formats for given file:

		bd --outputs image.pcd

Convert the given Kodak Photo CD image to a JPEG image.  Produces file image.jpg:

		bd -o jpg image.pcd

Convert a directory of images into the JPEG format:

		bd -o jpg images/

List available extractors for given file:

		bd --extractors image.jpg

Extract data from files contents (e.g. tags, previews, analysis, and other derived products).  Produces file image.json:

		bd image.jpg

Submit file to a specific extractor (in this example, the OCR extractor) for metadata extraction

		bd -e "ncsa.image.ocr" sample.jpg

Submit file to a specific extractor for metadata extraction with one or more parameters (in this example, setting dummy
parameters for OCR page segmentation mode and language). Please note that sending parameters option is supported only
when submitting file to a specific extractor.

		bd -e "ncsa.image.ocr" -p "psm=1" -p "lang=en" sample.jpg

Chain conversion and extraction.  Equivalent to the previous two examples:

		bd -o jpg image.pcd | bd

Index files within a directory:

		bd images/

Search for a similar file within a directory that has already been indexed:

		bd --find /path/image.jpg

Read input filename from a text file. This feature can be used to integrate BD-CLI with other programs by passing
filename around. Here input.txt can contain one input filename:

		bd < input.txt
		bd -o jpg < input.txt

