Options

-h, --help

Displays the command’s help text and exits.

-t, --show-traceback

Shows the full traceback when an error occurs.

--fields FIELD,FIELD,...

Specifies the sbJSON fields that should be queried.

Example:

pwfdf |command| --fields id,title,summary
pwfdf |command| --fields "id title summary"

--timeout SECONDS

Specifies the maximum allowed amount of time to connect with the ScienceBase server. Raises an error if the command cannot connect in this time frame. Defaults to 15 seconds.

Example:

pwfdf |command| --timeout 60

Logging

-q, --quiet

Do not log progress messages to the console.

Example:

pwfdf |command| -q

-v, --verbose

Prints more detailed progress messages to the console. (Useful for debugging).

Example:

pwfdf |command| -v

--log PATH

Logs detailed progress to the indicated file

Example:

pwfdf |command| --log my-file.log

--rotate-bytes N

A maximum allowed file size (in bytes), after which the log file will be rotated.

Example:

pwfdf |command| --log my-file.log --rotate-bytes 500000

--backup-count N

When rotating file logs, the number of backup log files to save. Defaults to 1.

Example:

pwfdf |command| --log my-file.log --rotate-bytes 500000 --backup-count 3