- show
- --version
- --help
Examples:
Usage: pfb show [OPTIONS] COMMAND [ARGS]...
Show records of the PFB file.
Specify a sub-command to show other information.
Options:
-i, --input FILENAME The PFB file.
-n, --limit INTEGER How many records to show, ignored for sub-commands.
[default: no limit]
Commands:
metadata Show the metadata of the PFB file.
nodes Show all the node names in the PFB file.
schema Show the schema of the PFB file.
Examples:
schema:
pfb show -i data.avro schema
./gradlew run --args="show -i data.avro schema"
nodes:
pfb show -i data.avro nodes
./gradlew run --args="show -i data.avro nodes"
metadata:
pfb show -i data.avro metadata
./gradlew run --args="show -i data.avro metadata"
records:
pfb show -i data.avro -n 5
./gradlew run --args="show -i data.avro -n 5"
Run the following command to build the library and CLI jar and execute a command:
./gradlew run --args=<command>
Run the following command to build the library and CLI jar:
./gradlew :cli:assembleDist
Unzip the distribution
unzip cli/build/distributions/cli-<VERSION>.zip
Run commands
./cli-<VERSION>/bin/cli <command>
Run the following command to build the library and CLI jar:
./gradlew :cli:jar
Then, you can use the CLI with the following command:
java -jar "cli/build/libs/java-pfb-cli-<VERSION>.jar" <command>
An alias can be created to simplify this command:
alias pfb='java -jar "cli/build/libs/java-pfb-cli-<VERSION>.jar"'
Example usage of the alias:
pfb --version
- Download Jar from latest Github release.
- Note the location of the downloaded jar and run the jar with the following command:
java -cp "<PATH-TO-JAR>" bio.terra.pfb.JavaPfbCommand <command>
- Download Distribution zip from latest Github release.
- Unzip the distribution
unzip <PATH-TO-ZIP>/cli-<VERSION>.zip
- Note the location of the unzipped distribution and run the CLI with the following command:
./cli-<VERSION>/bin/cli --version
Github release containing the CLI jar is automatically generated via Github actions when a change is pushed to main.